Class RangeRestrictionFactory

java.lang.Object

com.github.rvesse.airline.restrictions.factories.RangeRestrictionFactory

All Implemented Interfaces:

ArgumentsRestrictionFactory, OptionRestrictionFactory

public class RangeRestrictionFactory
extends Object
implements OptionRestrictionFactory, ArgumentsRestrictionFactory

Factory which generates range restrictions from a variety of different range annotations

Field Summary

Fields

Modifier and Type	Field	Description
private static final Comparator<Object>	BYTE_COMPARATOR
private static final Comparator<Object>	DOUBLE_COMPARATOR
private static final Comparator<Object>	FLOAT_COMPARATOR
private static final Comparator<Object>	INTEGER_COMPARATOR
private static final Comparator<Object>	LONG_COMPARATOR
private static final Comparator<Object>	SHORT_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
RangeRestrictionFactory()

Method Summary

Modifier and Type	Method	Description
final ArgumentsRestriction	createArgumentsRestriction(Annotation annotation)	Tries to create an arguments restriction from the given annotation
protected RangeRestriction	createByteRange(Annotation annotation)
protected final AbstractCommonRestriction	createCommon(Annotation annotation)	Handles converting all the basic range annotations into appropriate range restrictions
protected RangeRestriction	createDoubleRange(Annotation annotation)
protected RangeRestriction	createFloatRange(Annotation annotation)
protected RangeRestriction	createIntegerRange(Annotation annotation)
protected AbstractCommonRestriction	createLengthRange(Annotation annotation)
protected RangeRestriction	createLexicalRange(Annotation annotation)
protected RangeRestriction	createLongRange(Annotation annotation)
final OptionRestriction	createOptionRestriction(Annotation annotation)	Try and create an option restriction from the given annotation
protected RangeRestriction	createShortRange(Annotation annotation)
protected AbstractCommonRestriction	createUnknownRange(Annotation annotation)	Handles turning unknown annotations into range restrictions, derived factories can extend this to add support for additional range restrictions
protected List<Class<? extends Annotation>>	supportedAnnotations()
List<Class<? extends Annotation>>	supportedArgumentsAnnotations()	Gets a list of annotations that this factory can convert into arguments restrictions
List<Class<? extends Annotation>>	supportedOptionAnnotations()	Gets a list of annotations that this factory can convert into option restrictions

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LONG_COMPARATOR

private static final Comparator<Object> LONG_COMPARATOR

INTEGER_COMPARATOR

private static final Comparator<Object> INTEGER_COMPARATOR

SHORT_COMPARATOR

private static final Comparator<Object> SHORT_COMPARATOR

BYTE_COMPARATOR

private static final Comparator<Object> BYTE_COMPARATOR

DOUBLE_COMPARATOR

private static final Comparator<Object> DOUBLE_COMPARATOR

FLOAT_COMPARATOR

private static final Comparator<Object> FLOAT_COMPARATOR

Constructor Details

RangeRestrictionFactory

public RangeRestrictionFactory()

Method Details

createOptionRestriction

public final OptionRestriction createOptionRestriction(Annotation annotation)

Description copied from interface: OptionRestrictionFactory

Try and create an option restriction from the given annotation

Specified by:

createOptionRestriction in interface OptionRestrictionFactory

Parameters:

annotation - Annotation

Returns:

Option restriction or null if this factory cannot create a restriction from the given annotation

createArgumentsRestriction

public final ArgumentsRestriction createArgumentsRestriction(Annotation annotation)

Description copied from interface: ArgumentsRestrictionFactory

Tries to create an arguments restriction from the given annotation

Specified by:

createArgumentsRestriction in interface ArgumentsRestrictionFactory

Parameters:

annotation - Annotation

Returns:

Arguments restriction or null if this factory cannot create a restriction from the given annotation

createCommon

protected final AbstractCommonRestriction createCommon(Annotation annotation)

Handles converting all the basic range annotations into appropriate range restrictions

Parameters:

annotation - Annotation to create range from

Returns:

Range restriction

createUnknownRange

protected AbstractCommonRestriction createUnknownRange(Annotation annotation)

Handles turning unknown annotations into range restrictions, derived factories can extend this to add support for additional range restrictions

Parameters:

annotation - Annotation to create range from

Returns:

Range restriction or null if not a supported annotation

createLengthRange

protected AbstractCommonRestriction createLengthRange(Annotation annotation)

createLexicalRange

protected RangeRestriction createLexicalRange(Annotation annotation)

createFloatRange

protected RangeRestriction createFloatRange(Annotation annotation)

createDoubleRange

protected RangeRestriction createDoubleRange(Annotation annotation)

createByteRange

protected RangeRestriction createByteRange(Annotation annotation)

createShortRange

protected RangeRestriction createShortRange(Annotation annotation)

createIntegerRange

protected RangeRestriction createIntegerRange(Annotation annotation)

createLongRange

protected RangeRestriction createLongRange(Annotation annotation)

supportedAnnotations

protected List<Class<? extends Annotation>> supportedAnnotations()

supportedArgumentsAnnotations

public List<Class<? extends Annotation>> supportedArgumentsAnnotations()

Description copied from interface: ArgumentsRestrictionFactory

Gets a list of annotations that this factory can convert into arguments restrictions

Specified by:

supportedArgumentsAnnotations in interface ArgumentsRestrictionFactory

Returns:

List of supported annotations

supportedOptionAnnotations

public List<Class<? extends Annotation>> supportedOptionAnnotations()

Description copied from interface: OptionRestrictionFactory

Gets a list of annotations that this factory can convert into option restrictions

Specified by:

supportedOptionAnnotations in interface OptionRestrictionFactory

Returns:

List of supported annotations