com.bigzip.plugin.support.ui
Class FileQueueEntry

java.lang.Object
  |
  +--com.bigzip.plugin.support.ui.FileQueueEntry

public class FileQueueEntry
extends java.lang.Object

This is an information container for each of the files added to a file queue. The file queue will construct an instance of this class for each file added.


Constructor Summary
FileQueueEntry(TypeField type, java.lang.String filename, java.io.File directory, java.lang.Object options)
          Creates a new FileQueueEntry.
 
Method Summary
 java.io.File getDirectory()
          Retrieves the directory of the queued file.
 java.lang.String getFilename()
          Retrieves the name of the queued file.
 java.lang.Object getOptions()
          Retrieves the momento object retrieved from the file queue accessory at the time the file was queued, or null if the file queue has no accessory.
 java.io.File getPath()
          Retrieves a full path to the queued file.
 TypeField getType()
          Retrieves the type of the queued file.
 void setDirectory(java.io.File directory)
          Sets the directory of this queued file.
 void setFilename(java.lang.String filename)
          Sets the filename of this queued file.
 void setOptions(java.lang.Object options)
          Sets the momento object of this queued file.
 void setType(TypeField type)
          Sets the type of this queued file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileQueueEntry

public FileQueueEntry(TypeField type,
                      java.lang.String filename,
                      java.io.File directory,
                      java.lang.Object options)
Creates a new FileQueueEntry.
Parameters:
type - The nature/type of the file.
filename - The name of the queued file.
directory - The directory of the queued file.
options - The momento objects retrieved from the file queue accessory, or null if the file queue has no accessory.
Method Detail

getFilename

public java.lang.String getFilename()
Retrieves the name of the queued file.

getOptions

public java.lang.Object getOptions()
Retrieves the momento object retrieved from the file queue accessory at the time the file was queued, or null if the file queue has no accessory.

getPath

public java.io.File getPath()
Retrieves a full path to the queued file. This is the combination of the queued file's filename and directory.

getDirectory

public java.io.File getDirectory()
Retrieves the directory of the queued file.

getType

public TypeField getType()
Retrieves the type of the queued file. This is taken as the file's extention.

setType

public void setType(TypeField type)
Sets the type of this queued file.

setFilename

public void setFilename(java.lang.String filename)
Sets the filename of this queued file.

setOptions

public void setOptions(java.lang.Object options)
Sets the momento object of this queued file.

setDirectory

public void setDirectory(java.io.File directory)
Sets the directory of this queued file.