org.schmant.arg
Class InterpretAsReadOnlyDirectoryStrategy

java.lang.Object
  extended by org.schmant.arg.AbstractArgumentInterpretationStrategy<T>
      extended by org.schmant.arg.AbstractOneToOneArgumentInterpretationStrategy<DirectoryRepresentation>
          extended by org.schmant.arg.InterpretAsReadOnlyDirectoryStrategy
All Implemented Interfaces:
ArgumentInterpretationStrategy<DirectoryRepresentation>

public class InterpretAsReadOnlyDirectoryStrategy
extends AbstractOneToOneArgumentInterpretationStrategy<DirectoryRepresentation>

This strategy is used to interpret objects into read only DirectoryView:s. It is documented in the |ai:ai_read_only_directory:User's Guide|.

For most cases, the constants AS_SINGLE and AS_SEVERAL can be used instead of creating a new object.

Since:
1.0
Author:
Karl Gustafsson

Field Summary
static InterpretAsReadOnlyDirectoryStrategy AS_SEVERAL
          This object can be used for interpreting objects into one or several read only DirectoryRepresentation objects.
static InterpretAsReadOnlyDirectoryStrategy AS_SINGLE
          This object can be used for interpreting objects into a single read only DirectoryRepresentation object.
 
Fields inherited from interface org.schmant.arg.ArgumentInterpretationStrategy
ALLOW_NOT_INTERPRETED, ALLOW_ONE_AND_ONLY_ONE_RESULT_OBJECT
 
Constructor Summary
InterpretAsReadOnlyDirectoryStrategy(int... configuration)
           
 
Method Summary
protected  Class<DirectoryRepresentation> getTargetType()
          Subclasses implement this to return the type that they interpret objects as.
protected  DirectoryRepresentation interpretObject(Object o, List<String> t)
          Subclasses implement this to interpret the supplied object.
 
Methods inherited from class org.schmant.arg.AbstractOneToOneArgumentInterpretationStrategy
interpretList
 
Methods inherited from class org.schmant.arg.AbstractArgumentInterpretationStrategy
checkConfiguration, convertBackslashesToSlashes, getExistingFileFromCharSequence, getParentFile, trace, validateResult
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AS_SEVERAL

public static final InterpretAsReadOnlyDirectoryStrategy AS_SEVERAL
This object can be used for interpreting objects into one or several read only DirectoryRepresentation objects.


AS_SINGLE

public static final InterpretAsReadOnlyDirectoryStrategy AS_SINGLE
This object can be used for interpreting objects into a single read only DirectoryRepresentation object.

Constructor Detail

InterpretAsReadOnlyDirectoryStrategy

public InterpretAsReadOnlyDirectoryStrategy(int... configuration)
Method Detail

getTargetType

protected Class<DirectoryRepresentation> getTargetType()
Description copied from class: AbstractArgumentInterpretationStrategy
Subclasses implement this to return the type that they interpret objects as.

Specified by:
getTargetType in class AbstractArgumentInterpretationStrategy<DirectoryRepresentation>
Returns:
The target type of the interpretation.

interpretObject

protected DirectoryRepresentation interpretObject(Object o,
                                                  List<String> t)
Description copied from class: AbstractOneToOneArgumentInterpretationStrategy
Subclasses implement this to interpret the supplied object.

Specified by:
interpretObject in class AbstractOneToOneArgumentInterpretationStrategy<DirectoryRepresentation>
Parameters:
o - The object to interpret.
t - The interpretation trace list. The list should be populated by this method.
Returns:
The interpreted object or null if it could not be interpreted.