au.com.prunge.jgenfile
Interface Directory

All Superinterfaces:
Item
All Known Implementing Classes:
LocalDirectory

public interface Directory
extends Item

A directory is an item that contains other items within it.

Version:
1.0
Author:
Peter Runge

Method Summary
 au.com.prunge.jgenfile.CanCreateFileOperation createCanCreateFileOperation()
          Creates an operation to test whether an empty file can be created in this directory.
 au.com.prunge.jgenfile.CanCreateLinkOperation createCanCreateLinkOperation()
          Creates an operation to test whether a link can be created in this directory.
 au.com.prunge.jgenfile.CanCreateSubdirectoryOperation createCanCreateSubdirectoryOperation()
          Creates an operation to test whether an empty subdirectory can be created in this directory.
 au.com.prunge.jgenfile.CanGetChildOperation createCanGetChildOperation(String childName)
          Creates an operation that tests whether an item with the specified name exists in this directory.
 au.com.prunge.jgenfile.CanGetChildrenOperation createCanGetChildrenOperation()
          Creates an operation to test whether the children of this directory can be acquired.
 au.com.prunge.jgenfile.CanGetItemFromRelativeReferenceOperation createCanGetItemFromRelativeReferenceOperation(au.com.prunge.jgenfile.RelativeItemReference ref)
          Creates an operation that tests whether an item in the file system can be acquired given the specified relative reference using this directory as a starting point for the refence.
 au.com.prunge.jgenfile.CreateFileOperation createCreateFileOperation(String name)
          Creates an operation to create an empty file in this directory.
 au.com.prunge.jgenfile.CreateLinkOperation createCreateLinkOperation(au.com.prunge.jgenfile.Item item)
          Creates an operation that will create a link in this directory to the specified item.
 au.com.prunge.jgenfile.CreateSubdirectoryOperation createCreateSubdirectoryOperation(String name)
          Creates an operation to create an empty subdirectory in this directory.
 au.com.prunge.jgenfile.GetChildOperation createGetChildOperation(String childName)
          Creates an operation that retrieves the item with the specified name that exists in this directory.
 au.com.prunge.jgenfile.GetChildrenOperation createGetChildrenOperation()
          Creates an operation to get the children in this directory through a list.
 au.com.prunge.jgenfile.GetItemFromRelativeReferenceOperation createGetItemFromRelativeReferenceOperation(au.com.prunge.jgenfile.RelativeItemReference ref)
          Creates an operation that gets an item in the file system given a relative reference using this directory as a starting point for the reference.
 
Methods inherited from interface au.com.prunge.jgenfile.Item
createCanCopyItemOperation, createCanCopyItemToDestinationOperation, createCanCopyItemToDestinationOperation, createCanDeleteOperation, createCanGetAbsolutePathOperation, createCanGetMetadataOperation, createCanGetParentOperation, createCanGetRelativePathOperation, createCanSetMetadataOperation, createCanSetNameOperation, createCanSetParentOperation, createCopyOperation, createCopyOperation, createDeleteItemOperation, createGetAbsolutePathOperation, createGetAllMetadataOperation, createGetMetadataKeysOperation, createGetMetadataOperation, createGetParentOperation, createGetRelativePathOperation, createSetMetadataOperation, createSetNameOperation, createSetParentOperation, getFileSystem, getName
 

Method Detail

createGetChildrenOperation

public au.com.prunge.jgenfile.GetChildrenOperation createGetChildrenOperation()
                                                                       throws JGenFileException
Creates an operation to get the children in this directory through a list.

Throws:
JGenFileException - if the operation could not be created.

createCanGetChildrenOperation

public au.com.prunge.jgenfile.CanGetChildrenOperation createCanGetChildrenOperation()
                                                                             throws JGenFileException
Creates an operation to test whether the children of this directory can be acquired. This test is for both the GetChildrenOperation and GetChildOperation.

Throws:
JGenFileException - if the operation could not be created.

createGetChildOperation

public au.com.prunge.jgenfile.GetChildOperation createGetChildOperation(String childName)
                                                                 throws JGenFileException
Creates an operation that retrieves the item with the specified name that exists in this directory.

This operation can be used to test whether a child with a certain name exists in this directory.

Parameters:
childName - the name of the child to retrieve.
Throws:
JGenFileException - if the operation could not be created.

createCanGetChildOperation

public au.com.prunge.jgenfile.CanGetChildOperation createCanGetChildOperation(String childName)
                                                                       throws JGenFileException
Creates an operation that tests whether an item with the specified name exists in this directory.

Parameters:
childName - the name of the child to find.
Throws:
JGenFileException - if the operation could not be created.

createCreateSubdirectoryOperation

public au.com.prunge.jgenfile.CreateSubdirectoryOperation createCreateSubdirectoryOperation(String name)
                                                                                     throws JGenFileException
Creates an operation to create an empty subdirectory in this directory.

Parameters:
name - the name of the new subdirectory.
Throws:
JGenFileException - if the operation could not be created.

createCanCreateSubdirectoryOperation

public au.com.prunge.jgenfile.CanCreateSubdirectoryOperation createCanCreateSubdirectoryOperation()
                                                                                           throws JGenFileException
Creates an operation to test whether an empty subdirectory can be created in this directory.

Throws:
JGenFileException - if the operation could not be created.

createCreateFileOperation

public au.com.prunge.jgenfile.CreateFileOperation createCreateFileOperation(String name)
                                                                     throws JGenFileException
Creates an operation to create an empty file in this directory.

Parameters:
name - the name of the new file.
Throws:
JGenFileException - if the operation could not be created.

createCanCreateFileOperation

public au.com.prunge.jgenfile.CanCreateFileOperation createCanCreateFileOperation()
                                                                           throws JGenFileException
Creates an operation to test whether an empty file can be created in this directory.

Throws:
JGenFileException - if the operation could not be created.

createCreateLinkOperation

public au.com.prunge.jgenfile.CreateLinkOperation createCreateLinkOperation(au.com.prunge.jgenfile.Item item)
                                                                     throws JGenFileException
Creates an operation that will create a link in this directory to the specified item.

Parameters:
item - the target of the new link.
Throws:
JGenFileException - if the operation could not be created.

createCanCreateLinkOperation

public au.com.prunge.jgenfile.CanCreateLinkOperation createCanCreateLinkOperation()
                                                                           throws JGenFileException
Creates an operation to test whether a link can be created in this directory.

Throws:
JGenFileException - if the operation could not be created.

createGetItemFromRelativeReferenceOperation

public au.com.prunge.jgenfile.GetItemFromRelativeReferenceOperation createGetItemFromRelativeReferenceOperation(au.com.prunge.jgenfile.RelativeItemReference ref)
                                                                                                         throws JGenFileException,
                                                                                                                NullPointerException
Creates an operation that gets an item in the file system given a relative reference using this directory as a starting point for the reference.

Parameters:
ref - a relative reference to the item.
Throws:
JGenFileException - if an error occurs creating the operation.
NullPointerException - if ref is null.

createCanGetItemFromRelativeReferenceOperation

public au.com.prunge.jgenfile.CanGetItemFromRelativeReferenceOperation createCanGetItemFromRelativeReferenceOperation(au.com.prunge.jgenfile.RelativeItemReference ref)
                                                                                                               throws JGenFileException,
                                                                                                                      NullPointerException
Creates an operation that tests whether an item in the file system can be acquired given the specified relative reference using this directory as a starting point for the refence.

Parameters:
ref - a relative reference to the item.
Throws:
JGenFileException - if an error occurs creating the operation.
NullPointerException - if ref is null.