|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An item represents a file or directory in a file system. Usually items will implement either the File or Directory interfaces.
Method Summary | |
au.com.prunge.jgenfile.CanCopyItemOperation |
createCanCopyItemOperation()
Creates an operation that tests whether this item can be copied. |
au.com.prunge.jgenfile.CanCopyItemToDestinationOperation |
createCanCopyItemToDestinationOperation(au.com.prunge.jgenfile.Directory destination)
Creates an operation that tests whether this item can be copied into the specified directory keeping its current name. |
au.com.prunge.jgenfile.CanCopyItemToDestinationOperation |
createCanCopyItemToDestinationOperation(au.com.prunge.jgenfile.Directory destination,
String newName)
Creates an operation that tests whether this item can be copied into the specified directory using the specified name. |
au.com.prunge.jgenfile.CanDeleteItemOperation |
createCanDeleteOperation()
Creates an operation that tests whether this item can be deleted. |
au.com.prunge.jgenfile.CanGetAbsolutePathOperation |
createCanGetAbsolutePathOperation()
Creates an operation that tests whether the absolute path of this item can be acquired. |
au.com.prunge.jgenfile.CanGetMetadataOperation |
createCanGetMetadataOperation(Set metadataKeySet)
Creates an operation that tests whether the specified metadata is accessible for this item. |
au.com.prunge.jgenfile.CanGetParentOperation |
createCanGetParentOperation()
Creates an operation that will test whether the parent of this item can be acquired. |
au.com.prunge.jgenfile.CanGetRelativePathOperation |
createCanGetRelativePathOperation(au.com.prunge.jgenfile.Directory toAncestor)
Creates an operation that tests whether the relative path of this item up to and including toAncestor
can be acquired. |
au.com.prunge.jgenfile.CanSetMetadataOperation |
createCanSetMetadataOperation(Set metadataKeySet)
Creates an operation that tests whether the specified metadata can be set for this item. |
au.com.prunge.jgenfile.CanSetNameOperation |
createCanSetNameOperation()
Creates an operation that tests whether the name of this item can be changed. |
au.com.prunge.jgenfile.CanSetParentOperation |
createCanSetParentOperation()
Creates an operation that tests whether the parent of this item can be changed. |
au.com.prunge.jgenfile.CopyItemOperation |
createCopyOperation(au.com.prunge.jgenfile.Directory destination)
Creates an operation that copies this item to the specified destination directory. |
au.com.prunge.jgenfile.CopyItemOperation |
createCopyOperation(au.com.prunge.jgenfile.Directory destination,
String newName)
Creates an operation that copies this item to the specified destination directory giving the copied item a name of newName . |
au.com.prunge.jgenfile.DeleteItemOperation |
createDeleteItemOperation()
Creates an operation that will delete this item. |
au.com.prunge.jgenfile.GetAbsolutePathOperation |
createGetAbsolutePathOperation()
Creates an operation that gets the absolute path of this item. |
au.com.prunge.jgenfile.GetMetadataOperation |
createGetAllMetadataOperation()
Creates an operation that acquires all available metadata for this item. |
au.com.prunge.jgenfile.GetAllMetadataKeysOperation |
createGetMetadataKeysOperation()
Creates an operation that gets all the keys for the metadata of this item. |
au.com.prunge.jgenfile.GetMetadataOperation |
createGetMetadataOperation(Set metadataKeySet)
Creates an operation that acquires the specified metadata. |
au.com.prunge.jgenfile.GetParentOperation |
createGetParentOperation()
Creates an operation that will retrieve the parent of this item. |
au.com.prunge.jgenfile.GetRelativePathOperation |
createGetRelativePathOperation(au.com.prunge.jgenfile.Directory toAncestor)
Creates an operation that gets the relative path of this item up to and including toAncestor . |
au.com.prunge.jgenfile.SetMetadataOperation |
createSetMetadataOperation(Map metadataMap)
Creates an operation that sets the specified metadata for this item. |
au.com.prunge.jgenfile.SetNameOperation |
createSetNameOperation(String newName)
Creates an operation that will set the name of this item. |
au.com.prunge.jgenfile.SetParentOperation |
createSetParentOperation(au.com.prunge.jgenfile.Directory parent)
Creates an operation that will set the parent of (i.e. |
au.com.prunge.jgenfile.FileSystem |
getFileSystem()
Returns the file system this item exists in. |
String |
getName()
Returns the name of the item. |
Method Detail |
public String getName() throws JGenFileException
JGenFileException
- if an error occurs
getting the name of the
item.public au.com.prunge.jgenfile.FileSystem getFileSystem() throws JGenFileException
JGenFileException
- if an error occurs.public au.com.prunge.jgenfile.SetNameOperation createSetNameOperation(String newName) throws JGenFileException
newName
- the new name of the item.
JGenFileException
- if the operation could
not be created.public au.com.prunge.jgenfile.CanSetNameOperation createCanSetNameOperation() throws JGenFileException
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.GetParentOperation createGetParentOperation() throws JGenFileException
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.CanGetParentOperation createCanGetParentOperation() throws JGenFileException
JGenFileException
- if the operation could not be
created.public au.com.prunge.jgenfile.SetParentOperation createSetParentOperation(au.com.prunge.jgenfile.Directory parent) throws JGenFileException
parent
- the new parent to attempt to set with the
operation.
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.CanSetParentOperation createCanSetParentOperation() throws JGenFileException
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.DeleteItemOperation createDeleteItemOperation() throws JGenFileException
JGenFileException
- if the operation could not be
created.public au.com.prunge.jgenfile.CanDeleteItemOperation createCanDeleteOperation() throws JGenFileException
JGenFileException
- if the operation could not be
created.public au.com.prunge.jgenfile.GetMetadataOperation createGetMetadataOperation(Set metadataKeySet) throws JGenFileException, NullPointerException
metadataKeySet
- a set of MetadataKey
objects.
JGenFileException
- if the operation could not be
created.
NullPointerException
- if metadataKeySet
is null.MetadataKey
public au.com.prunge.jgenfile.GetMetadataOperation createGetAllMetadataOperation() throws JGenFileException
JGenFileException
- if the operation could not be
created.public au.com.prunge.jgenfile.GetAllMetadataKeysOperation createGetMetadataKeysOperation() throws JGenFileException
An element of metadata may be either readable, writable or both. If a key exists in the set returned by this operation, the corresponding element of metadata is either readable, writable or both.
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.CanGetMetadataOperation createCanGetMetadataOperation(Set metadataKeySet) throws JGenFileException, NullPointerException
metadataKeySet
- a set of MetadataKey
objects representing the
elements of metadata to test for.
JGenFileException
- if the operation could not be
created.
NullPointerException
- if metadataKeySet
is null.MetadataKey
public au.com.prunge.jgenfile.SetMetadataOperation createSetMetadataOperation(Map metadataMap) throws JGenFileException, NullPointerException
The map's keys should consist of MetadataKey objects, the values should be appropriate for each key.
metadataMap
- a map of MetadataKeys to values.
JGenFileException
- if the operation could not be
created.
NullPointerException
- if metadataMap
is null.MetadataKey
public au.com.prunge.jgenfile.CanSetMetadataOperation createCanSetMetadataOperation(Set metadataKeySet) throws JGenFileException, NullPointerException
metadataKeySet
- a set of MetadataKey
objects representing the
elements of metadata to test for.
JGenFileException
- if the operation could not be
created.
NullPointerException
- if metadataKeySet
is null.MetadataKey
public au.com.prunge.jgenfile.CopyItemOperation createCopyOperation(au.com.prunge.jgenfile.Directory destination) throws JGenFileException
destination
- the destination directory.
JGenFileException
- if the operation could not be
created.public au.com.prunge.jgenfile.CopyItemOperation createCopyOperation(au.com.prunge.jgenfile.Directory destination, String newName) throws JGenFileException
newName
.
destination
- the destination directory.newName
- the name to give the copied item.
JGenFileException
- if the operation could not be
created.public au.com.prunge.jgenfile.CanCopyItemOperation createCanCopyItemOperation() throws JGenFileException
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.CanCopyItemToDestinationOperation createCanCopyItemToDestinationOperation(au.com.prunge.jgenfile.Directory destination) throws JGenFileException
destination
- the destination directory.
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.CanCopyItemToDestinationOperation createCanCopyItemToDestinationOperation(au.com.prunge.jgenfile.Directory destination, String newName) throws JGenFileException
destination
- the destination directory.newName
- the name the copied item would have.
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.GetAbsolutePathOperation createGetAbsolutePathOperation() throws JGenFileException
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.CanGetAbsolutePathOperation createCanGetAbsolutePathOperation() throws JGenFileException
JGenFileException
- if the operation could not
be created.public au.com.prunge.jgenfile.GetRelativePathOperation createGetRelativePathOperation(au.com.prunge.jgenfile.Directory toAncestor) throws JGenFileException
toAncestor
.
toAncestor
- the ancestor to get the relative
path up to. The path will start
from this item and go up through
each parent of this item until
toAncestor
is hit.
toAncestor
will be
the most distant ancestor included
in the path.
JGenFileException
- if the operation could not
be created.
NullPointerException
- if toAncestor
is null.public au.com.prunge.jgenfile.CanGetRelativePathOperation createCanGetRelativePathOperation(au.com.prunge.jgenfile.Directory toAncestor) throws JGenFileException
toAncestor
can be acquired.
toAncestor
- the ancestor to get the relative
path up to. The path will start
from this item and go up through
each parent of this item until
toAncestor
is hit.
JGenFileException
- if the operation could not
be created.
NullPointerException
- if toAncestor
is null.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |