org.schmant.arg
Class InterpretAsReadableFileStrategy

java.lang.Object
  org.schmant.arg.AbstractArgumentInterpretationStrategy<T>
      org.schmant.arg.AbstractOneToOneArgumentInterpretationStrategy<T>
          org.schmant.arg.AbstractReadableFileArgumentInterpretationStrategy<ReadableFile>
              org.schmant.arg.InterpretAsReadableFileStrategy

All Implemented Interfaces:

ArgumentInterpretationStrategy<ReadableFile>

public class InterpretAsReadableFileStrategy
extends AbstractReadableFileArgumentInterpretationStrategy<ReadableFile>

This strategy is used to interpret objects into read only ReadableFile:s. It is documented in the |ai:ai_readable_file: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 InterpretAsReadableFileStrategy	AS_SEVERAL This object can be used for interpreting objects into one or several ReadableFile objects.
static InterpretAsReadableFileStrategy	AS_SINGLE This object can be used for interpreting objects into one ReadableFile object.

Fields inherited from interface org.schmant.arg.ArgumentInterpretationStrategy

ALLOW_NOT_INTERPRETED, ALLOW_ONE_AND_ONLY_ONE_RESULT_OBJECT

Constructor Summary

InterpretAsReadableFileStrategy(int... configuration)

Method Summary

protected Class<ReadableFile>	getTargetType() Subclasses implement this to return the type that they interpret objects as.
protected ReadableFile	interpretObject(Object o, List<String> t) Subclasses implement this to interpret the supplied object.

Methods inherited from class org.schmant.arg.AbstractReadableFileArgumentInterpretationStrategy

getNamedReadableFileInternal, getReadableFileInternal

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 InterpretAsReadableFileStrategy AS_SEVERAL

This object can be used for interpreting objects into one or several ReadableFile objects.

AS_SINGLE

public static final InterpretAsReadableFileStrategy AS_SINGLE

This object can be used for interpreting objects into one ReadableFile object.

Constructor Detail

InterpretAsReadableFileStrategy

public InterpretAsReadableFileStrategy(int... configuration)

Method Detail

getTargetType

protected Class<ReadableFile> getTargetType()

Description copied from class: AbstractArgumentInterpretationStrategy

Subclasses implement this to return the type that they interpret objects as.

Specified by:

getTargetType in class AbstractArgumentInterpretationStrategy<ReadableFile>

Returns:

The target type of the interpretation.

interpretObject

protected ReadableFile 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<ReadableFile>

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.