com.github.theholywaffle.teamspeak3.api.wrapper

Class FileListEntry

java.lang.Object

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

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

com.github.theholywaffle.teamspeak3.api.wrapper.FileListEntry

Direct Known Subclasses:

IconFile

public class FileListEntry
extends FileInfo

Field Summary

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

EMPTY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
long	getFileSize() Gets the size of the file in bytes.
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.
long	getUploadedBytes() If this file is still uploading, this method will return how many bytes have already been uploaded.
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.
boolean	isStillUploading() Returns true if this file was actively being uploaded at the time this object was created.

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

getChannelId, getLastModifiedDate

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

FileListEntry

public FileListEntry(Map<String,String> map)

Method Detail

getPath

public String getPath()

Description copied from class: FileInfo

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

Overrides:

getPath in class FileInfo

Returns:

the path to the file or directory

getName

public String getName()

Description copied from class: FileInfo

Gets the name of this file or directory.

Overrides:

getName in class FileInfo

Returns:

the name of this file or directory

getParentPath

public String getParentPath()

Description copied from class: FileInfo

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

Overrides:

getParentPath in class FileInfo

Returns:

the path to the parent directory

See Also:

FileInfo.getPath()

getFileSize

public long getFileSize()

Description copied from class: FileInfo

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.

Overrides:

getFileSize in class FileInfo

Returns:

the file's size

getType

public int getType()

Description copied from class: FileInfo

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

Consider using FileInfo.isFile() and FileInfo.isDirectory() instead.

Overrides:

getType in class FileInfo

Returns:

the type of this file entry

isFile

public boolean isFile()

Description copied from class: FileInfo

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

Overrides:

isFile in class FileInfo

Returns:

whether this is a file

isDirectory

public boolean isDirectory()

Description copied from class: FileInfo

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

Overrides:

isDirectory in class FileInfo

Returns:

whether this is a directory

isStillUploading

public boolean isStillUploading()

Returns true if this file was actively being uploaded at the time this object was created. Note that this will return false if a client has paused an upload.

Returns:

whether this file is actively being uploaded

getUploadedBytes

public long getUploadedBytes()

If this file is still uploading, this method will return how many bytes have already been uploaded. Otherwise the normal file size is returned.

Returns:

how many bytes of this file have been uploaded