Method Summary |
|
protected void | addAllowedMethods(String sMethod) Adds an allowed method to the list for this virtual file. |
public void | addChild(String sURI) Adds a path to this virtual file's children list. |
public void | addProperty(PropertyInstance prop) Adds a
PropertyInstance to the metadata for this vitual
file. |
public void | addVirtualFileListener(VirtualFileListener listener) Adds a
VirtualFileListener . |
public boolean | canLock() Checks to see if the logged in user will be able to lock this VirtualFile. |
public boolean | canUnlock() Checks to see if the logged in user will be able to unlock this VirtualFile. |
protected void | clearAllProperties() Clears all the metadata for this virtual file. |
protected void | clearAllowedMethods() Clears the list of allowed methods for this virtual file. |
protected void | clearChildren() Clears the list of paths of children of this collection. |
public void | clearFile() Clears all of the information about this virtual file and resets
all of the populated booleans to false. |
public StatusData | copy(String sNewPath, String sNewFilename) Copies the file to a new path with a new filename. |
public StatusData | copy(String sNewPath) Copies the file to a new path, giving the copy the same name as the current
version of the file. |
public StatusData | createShortcut(String sShortcutName, String sFromFullPath) Creates a new shortcut to a specified file with a specified name within
the current directory, only works on Virtual Files that are directories. |
public StatusData | delete() Deletes the file. |
protected void | discardChanges() Discards any changes that may have been made to this virtual file
since it was populate. |
public boolean | exists() Checks if this virtual file exists within the virtual file system
that this virtual file belongs to. |
public void | fireVirtualFileEvent(String sEventType) Creates and fires a
VirtualFileEvent to all the listeners. |
public void | fireVirtualFileEvent(String sEventType, int nEventAction, String sPath) Creates and fires a
VirtualFileEvent to all the listeners. |
public List | getAllowedMethods() Provides a list of the methods which might work for this VirtualFile. |
public List | getChildren() Returns a list of the paths that are children of this virtual file. |
public byte[] | getContent() Returns the contents for this virtual file. |
public String | getFileName() Returns the name of this virtual file. |
public String | getFilePath() Returns the path to the parent collection of this virtual file. |
public String | getFullPath() Gets the full path of the file. |
public String | getLockOwner() Returns the owner of the lock on the file, if there is one. |
public String | getLockToken() Returns the lock token for the lock on the file, if there is one. |
public List | getProperties() Returns a list of all the
PropertyInstance objects in this
virtual file's metadata. |
public PropertyInstance | getProperty(String sNamespaceURI, String sName) Returns a
PropertyInstance from the metadata for this
virtual file which matches the given namespace and name. |
public String | getState() Returns the current state of this virtual file. |
public AbstractVirtualFileSystem | getVFS() Returns the
AbstractVirtualFileSystem that this virtual file
belongs to. |
public boolean | hasChild(String sURI) Checks if this virtual file has a path as one of its children. |
public boolean | hasVirtualFileListeners() Checks if the file has any listeners. |
public boolean | isChanged() Checks if the in memory file has changed in anyway since it either came from
the Virtual File System or since it was last synchronized. |
protected boolean | isChildrenPopulated() Checks if the list of children for this virtual file has been
populated. |
public boolean | isContentChanged() Checks if the content for this virtual file has changes since it
was last populated. |
protected boolean | isContentPopulated() Checks if the content for this virtual file has been populated. |
public boolean | isDirectory() Checks if this virtual file is a collection. |
public boolean | isFullyPopulated() Checks if the file is fully populated, to allow for lazy partial instantiation. |
public boolean | isLocked() Checks if this virtual file is locked. |
public boolean | isMetadataChanged() Checks if the metadata for this virtual file has changed since it
was last populated. |
protected boolean | isMetadataPopulated() Checks if the metadata for this virtual file has been populated. |
public boolean | isOrderableDirectory() Checks if this collection is able to have the order of its
children set. |
public boolean | isPopulateLocked() Checks if this virtual file's lock information has been populated. |
public boolean | isVersionable() Checks if this VirtualFile is under version control. |
public boolean | isVirtualDirectory() |
public StatusData | lock() Locks the file to the logged in user. |
public StatusData | mkDir(String sDirname) Creates a new directory with the current one. |
public StatusData | move(String sNewPath, String sNewFilename) Moves the file to a new path with a new filename. |
public StatusData | move(String sNewPath) Moves the file to a new path. |
public void | refreshChildren() Refreshes the list of children for this virtual file. |
public void | refreshChildren(int nAction, String sChildPath) Refreshes the list of children for this virtual file. |
public void | removeChild(String sURI) Removes a path from this virtual file's children list. |
public void | removeProperty(String sNamespaceURI, String sName) Removes a
PropertyInstance from the metadata for this
virtual file. |
public void | removeVirtualFileListener(VirtualFileListener listener) Removes a
VirtualFileListener . |
public StatusData | rename(String sNewFilename) Renames the virtual file. |
public StatusData | setChildrenOrder(List children) Sets the order of the children of this virtual file. |
protected void | setChildrenPopulated(boolean bChildrenPopulated) Sets that the list of children for this virtual file has been
populated. |
public void | setContent(byte[] bs) Sets the content for this virtual file. |
protected void | setContentPopulated(boolean bContentPopulated) Sets that the content for this virtual file has been populated. |
public void | setFileName(String string) Sets the name of this virtual file. |
public void | setFilePath(String string) Sets the path to the parent collection for this virtual file. |
public void | setFullPath(String sFullPath) Sets the full path of this virtual file. |
public void | setIsDirectory(boolean bIsDirectory) Sets if this virtual file is a collection. |
public void | setIsVirtualDirectory(boolean bIsVirtual) |
public void | setLockOwner(String sLockOwner) Sets the owner of the lock on the file. |
public void | setLockToken(String sLockToken) Sets the lock token for the lock on the file. |
protected void | setMetadataPopulated(boolean bMetadataPopulated) Sets that the metadata for this virtual file has been populated. |
protected void | setOrderableDirectory(boolean b) Sets that the order of the children of this collection can be set. |
public void | setPopulateLocked(boolean bPopulateLocked) Sets the lock populated information for this virtual file. |
protected void | setState(String sState) Sets the current state of this virtual file. |
public void | setVFS(AbstractVirtualFileSystem vfs) Gives the file a hook to the file system it belongs to. |
protected void | setVersionable(boolean bVersionable) Sets if this VirtualFile is under version control. |
public StatusData | sync() Submits any changes that have been made to this virtual file back
to the underlying file system. |
public StatusData | unlock() Unlocks the file. |