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

java.lang.Object
  |
  +--au.com.prunge.jgenfile.impl.AbstractOperation
        |
        +--au.com.prunge.jgenfile.impl.AbstractFileSystemOperation
              |
              +--au.com.prunge.jgenfile.impl.local.LocalGetItemFromAbsoluteReferenceOperation

All Implemented Interfaces:

FileSystemOperation, GetItemFromAbsoluteReferenceOperation, Operation

public class LocalGetItemFromAbsoluteReferenceOperation

extends AbstractFileSystemOperation

implements GetItemFromAbsoluteReferenceOperation

An operation that creates an item object in the local file system from an absolute reference.

Version:

1.0

Author:

Peter Runge

Constructor Summary

LocalGetItemFromAbsoluteReferenceOperation(au.com.prunge.jgenfile.FileSystem fileSystem, au.com.prunge.jgenfile.AbsoluteItemReference ref)
Constructs a LocalGetItemFromAbsoluteReferenceOperation.

Method Summary

au.com.prunge.jgenfile.Item	getItemFromReference() Returns the item acquired with the reference.
au.com.prunge.jgenfile.AbsoluteItemReference	getReference() Returns the reference of the item.
void	runImpl() The actual run() implementation goes in this method.

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

getFileSystem

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

run

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

getFileSystem

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

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

Constructor Detail

LocalGetItemFromAbsoluteReferenceOperation

public LocalGetItemFromAbsoluteReferenceOperation(au.com.prunge.jgenfile.FileSystem fileSystem,
                                                  au.com.prunge.jgenfile.AbsoluteItemReference ref)

Constructs a LocalGetItemFromAbsoluteReferenceOperation.

Parameters:

fileSystem - the file system this operation is for.

ref - the reference to get the item from.

Method Detail

getReference

public au.com.prunge.jgenfile.AbsoluteItemReference getReference()

Description copied from interface: GetItemFromAbsoluteReferenceOperation

Returns the reference of the item.

Specified by:

getReference in interface GetItemFromAbsoluteReferenceOperation

Returns:

the reference of the item.

See Also:

GetItemFromAbsoluteReferenceOperation.getReference()

getItemFromReference

public au.com.prunge.jgenfile.Item getItemFromReference()
                                                 throws OperationNotFinishedException,
                                                        JGenFileException

Description copied from interface: GetItemFromAbsoluteReferenceOperation

Returns the item acquired with the reference.

Specified by:

getItemFromReference in interface GetItemFromAbsoluteReferenceOperation

Returns:

the acquired item.

Throws:

JGenFileException - if another error occurs.

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

See Also:

GetItemFromAbsoluteReferenceOperation.getItemFromReference()

runImpl

public void runImpl()
             throws ItemNotFoundException,
                    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.

ItemNotFoundException

See Also:

au.com.prunge.jgenfile.GetItemFromAbsoluteOperation#run()