org.schmant.arg
Class InterpretAsFutureEntityStrategy

java.lang.Object
  org.schmant.arg.AbstractArgumentInterpretationStrategy<T>
      org.schmant.arg.AbstractOneToOneArgumentInterpretationStrategy<FutureEntity>
          org.schmant.arg.InterpretAsFutureEntityStrategy

All Implemented Interfaces:

ArgumentInterpretationStrategy<FutureEntity>

public class InterpretAsFutureEntityStrategy
extends AbstractOneToOneArgumentInterpretationStrategy<FutureEntity>

This strategy is used to interpret objects into FutureEntity:s. It is documented in the |ai:ai_future_entity:User's Guide|.

For some cases, the constant AS_SINGLE_NO_SOURCE can be used instead of creating a new object.

Since:

1.0

Author:

Karl Gustafsson

Field Summary

static InterpretAsFutureEntityStrategy

AS_SINGLE_NO_SOURCE This object can be used for interpreting objects into a single FutureEntity object.

Fields inherited from interface org.schmant.arg.ArgumentInterpretationStrategy

ALLOW_NOT_INTERPRETED, ALLOW_ONE_AND_ONLY_ONE_RESULT_OBJECT

Constructor Summary

InterpretAsFutureEntityStrategy(Object source, int... configuration)

Method Summary

protected Class<FutureEntity>	getTargetType() Subclasses implement this to return the type that they interpret objects as.
protected FutureEntity	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_SINGLE_NO_SOURCE

public static final InterpretAsFutureEntityStrategy AS_SINGLE_NO_SOURCE

This object can be used for interpreting objects into a single FutureEntity object. This object has no source.

Constructor Detail

InterpretAsFutureEntityStrategy

public InterpretAsFutureEntityStrategy(Object source,
                                       int... configuration)

Method Detail

getTargetType

protected Class<FutureEntity> getTargetType()

Description copied from class: AbstractArgumentInterpretationStrategy

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

Specified by:

getTargetType in class AbstractArgumentInterpretationStrategy<FutureEntity>

Returns:

The target type of the interpretation.

interpretObject

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

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.