au.com.prunge.jgenfile.impl.local
Class LocalCreateSubdirectoryOperation

java.lang.Object
  |
  +--au.com.prunge.jgenfile.impl.AbstractOperation
        |
        +--au.com.prunge.jgenfile.impl.AbstractItemOperation
              |
              +--au.com.prunge.jgenfile.impl.AbstractDirectoryOperation
                    |
                    +--au.com.prunge.jgenfile.impl.local.LocalCreateSubdirectoryOperation

All Implemented Interfaces:

CreateSubdirectoryOperation, DirectoryOperation, ItemOperation, Operation

public class LocalCreateSubdirectoryOperation

extends AbstractDirectoryOperation

implements CreateSubdirectoryOperation

An operation that creates a subdirectory inside a local directory.

Version:

1.0

Author:

Peter Runge

Constructor Summary

LocalCreateSubdirectoryOperation(LocalDirectory directory, String name)
Constructs a LocalCreateSubdirectoryOperation.

Method Summary

au.com.prunge.jgenfile.Directory	getSubdirectory() Returns the newly created subdirectory.
String	getSubdirectoryName() Returns the name of the subdirectory to create.
void	runImpl() The actual run() implementation goes in this method.

Methods inherited from class au.com.prunge.jgenfile.impl.AbstractDirectoryOperation

getDirectory

Methods inherited from class au.com.prunge.jgenfile.impl.AbstractItemOperation

getItem

Methods inherited from class au.com.prunge.jgenfile.impl.AbstractOperation

abort, addOperationHints, checkRun, getLastRunException, getOperationHint, getOperationHints, hasRun, run, setLastRunException, setOperationHint, setOperationHints

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface au.com.prunge.jgenfile.CreateSubdirectoryOperation

run

Methods inherited from interface au.com.prunge.jgenfile.DirectoryOperation

getDirectory

Methods inherited from interface au.com.prunge.jgenfile.ItemOperation

getItem

Methods inherited from interface au.com.prunge.jgenfile.Operation

abort, addOperationHints, getLastRunException, getOperationHint, getOperationHints, hasRun, setOperationHint, setOperationHints

Constructor Detail

LocalCreateSubdirectoryOperation

public LocalCreateSubdirectoryOperation(LocalDirectory directory,
                                        String name)
                                 throws NullPointerException

Constructs a LocalCreateSubdirectoryOperation.

Parameters:

directory - the directory

Method Detail

getSubdirectoryName

public String getSubdirectoryName()

Description copied from interface: CreateSubdirectoryOperation

Returns the name of the subdirectory to create.

Specified by:

getSubdirectoryName in interface CreateSubdirectoryOperation

Returns:

the name of the subdirectory to create.

See Also:

CreateSubdirectoryOperation.getSubdirectoryName()

getSubdirectory

public au.com.prunge.jgenfile.Directory getSubdirectory()
                                                 throws OperationNotFinishedException,
                                                        JGenFileException

Description copied from interface: CreateSubdirectoryOperation

Returns the newly created subdirectory.

Specified by:

getSubdirectory in interface CreateSubdirectoryOperation

Returns:

the newly created subdirectory.

Throws:

OperationNotFinishedException - if this method was called and the run() method has not finished or has not been called.

JGenFileException - if another error occurs.

See Also:

CreateSubdirectoryOperation.getSubdirectory()

runImpl

public void runImpl()
             throws JGenFileException,
                    ItemNameInUseException

Description copied from class: AbstractOperation

The actual run() implementation goes in this method. Setting the last run exception and setting hasRun to true is not required by this method as it is handled by the run() method in this class.

If this method completes successfully (i.e. without throwing an exception), the last run exception is set to null indicating no exception occurred and subsequent calls to hasRun() will return true.

If this method throws an exception, the last run exception is filled in and hasRun() subsequent calls to hasRun() will return false.

Specified by:

runImpl in class AbstractOperation

Throws:

JGenFileException - if an error occurs.

ItemNameInUseException

See Also:

au.com.prunge.jgenfile.AbstractOperation#runImpl()