com.github.theholywaffle.teamspeak3.api.wrapper

Class FileInfo

java.lang.Object

com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

com.github.theholywaffle.teamspeak3.api.wrapper.FileInfo

Direct Known Subclasses:

FileListEntry

public class FileInfo
extends Wrapper

Field Summary

Fields inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

EMPTY

Constructor Summary

Constructors

Constructor and Description
FileInfo(Map<String,String> map)

Method Summary

Modifier and Type	Method and Description
int	getChannelId() Gets the ID of the channel this file is stored on.
long	getFileSize() Gets the size of the file in bytes.
Date	getLastModifiedDate() Gets the date of the last modification to this file.
String	getName() Gets the name of this file or directory.
String	getParentPath() Gets the path of the directory containing this file or directory.
String	getPath() Gets the path to this file or directory, including its name.
int	getType() Gets whether this entry is a directory or a file.
boolean	isDirectory() Returns true if this entry is a directory and not a file.
boolean	isFile() Returns true if this entry is a file and not a directory.

Methods inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

get, get, getBoolean, getBoolean, getDouble, getDouble, getInt, getInt, getLong, getLong, getMap, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileInfo

public FileInfo(Map<String,String> map)

Method Detail

getChannelId

public int getChannelId()

Gets the ID of the channel this file is stored on.

Returns:

the ID of the file's channel

getPath

public String getPath()

Gets the path to this file or directory, including its name. This path can be used in other file transfer commands.

Returns:

the path to the file or directory

getName

public String getName()

Gets the name of this file or directory.

Returns:

the name of this file or directory

getParentPath

public String getParentPath()

Gets the path of the directory containing this file or directory.

Returns:

the path to the parent directory

See Also:

getPath()

getFileSize

public long getFileSize()

Gets the size of the file in bytes. Note that this can return wrong values if the file is still being uploaded or if the upload has been paused by the uploading client.

Returns:

the file's size

getLastModifiedDate

public Date getLastModifiedDate()

Gets the date of the last modification to this file. The date has a one-second resolution.

Returns:

the file's last modification date

getType

public int getType()

Gets whether this entry is a directory or a file. 0 stands for a directory, 1 for a file.

Consider using isFile() and isDirectory() instead.

Returns:

the type of this file entry

isFile

public boolean isFile()

Returns true if this entry is a file and not a directory.

Returns:

whether this is a file

isDirectory

public boolean isDirectory()

Returns true if this entry is a directory and not a file.

Returns:

whether this is a directory