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

java.lang.Object
  |
  +--au.com.prunge.jgenfile.impl.AbstractOperation
        |
        +--au.com.prunge.jgenfile.impl.AbstractItemOperation
              |
              +--au.com.prunge.jgenfile.impl.AbstractFileOperation
                    |
                    +--au.com.prunge.jgenfile.impl.local.LocalGetFileAccessorOperation

All Implemented Interfaces:

FileOperation, GetFileAccessorOperation, ItemOperation, Operation

public class LocalGetFileAccessorOperation

extends AbstractFileOperation

implements GetFileAccessorOperation

An operation that obtains a file accessor for a local file.

Version:

1.0

Author:

Peter Runge

Constructor Summary

LocalGetFileAccessorOperation(LocalFile file, au.com.prunge.jgenfile.FileAccessorOptions options)
Constructs a LocalGetFileAccessorOperation.

Method Summary

au.com.prunge.jgenfile.FileAccessor	getFileAccessor() Returns the file accessor retrieved through this operation.
au.com.prunge.jgenfile.FileAccessorOptions	getOptions() Returns the options used to create the file accessor.
void	runImpl() The actual run() implementation goes in this method.

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

getFile

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.FileOperation

getFile

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, run, setOperationHint, setOperationHints

Constructor Detail

LocalGetFileAccessorOperation

public LocalGetFileAccessorOperation(LocalFile file,
                                     au.com.prunge.jgenfile.FileAccessorOptions options)
                              throws NullPointerException

Constructs a LocalGetFileAccessorOperation.

Parameters:

file - the file to create the operation for.

options - the file accessor options to use.

Throws:

NullPointerException - if options is null.

Method Detail

getOptions

public au.com.prunge.jgenfile.FileAccessorOptions getOptions()

Description copied from interface: GetFileAccessorOperation

Returns the options used to create the file accessor.

Specified by:

getOptions in interface GetFileAccessorOperation

Returns:

the options used to create the file accessor.

See Also:

GetFileAccessorOperation.getOptions()

getFileAccessor

public au.com.prunge.jgenfile.FileAccessor getFileAccessor()
                                                    throws OperationNotFinishedException,
                                                           JGenFileException

Description copied from interface: GetFileAccessorOperation

Returns the file accessor retrieved through this operation.

Specified by:

getFileAccessor in interface GetFileAccessorOperation

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:

GetFileAccessorOperation.getFileAccessor()

runImpl

public void runImpl()
             throws JGenFileException

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.

See Also:

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