Module com.github.rvesse.airline

Package com.github.rvesse.airline.restrictions.factories

Class OccurrencesRestrictionFactory

java.lang.Object

com.github.rvesse.airline.restrictions.factories.OccurrencesRestrictionFactory

All Implemented Interfaces:

ArgumentsRestrictionFactory, OptionRestrictionFactory

public class OccurrencesRestrictionFactory
extends java.lang.Object
implements OptionRestrictionFactory, ArgumentsRestrictionFactory

An annotation used to mark that an option must occur at most once

To more finely control the number of occurrences of an option use MinOccurrences and MaxOccurrences. If you simply wish to state that an option must occur then use Required.

Constructor Summary

Constructors

Constructor	Description
OccurrencesRestrictionFactory()

Method Summary

Modifier and Type	Method	Description
ArgumentsRestriction	createArgumentsRestriction(java.lang.annotation.Annotation annotation)	Tries to create an arguments restriction from the given annotation
protected OccurrencesRestriction	createCommon(java.lang.annotation.Annotation annotation)
OptionRestriction	createOptionRestriction(java.lang.annotation.Annotation annotation)	Try and create an option restriction from the given annotation
protected java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>>	supportedAnnotations()
java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>>	supportedArgumentsAnnotations()	Gets a list of annotations that this factory can convert into arguments restrictions
java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>>	supportedOptionAnnotations()	Gets a list of annotations that this factory can convert into option restrictions

Methods inherited from class java.lang.Object

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

Constructor Detail

OccurrencesRestrictionFactory

public OccurrencesRestrictionFactory()

Method Detail

createArgumentsRestriction

public ArgumentsRestriction createArgumentsRestriction(java.lang.annotation.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

createOptionRestriction

public OptionRestriction createOptionRestriction(java.lang.annotation.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

createCommon

protected OccurrencesRestriction createCommon(java.lang.annotation.Annotation annotation)

supportedAnnotations

protected java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> supportedAnnotations()

supportedArgumentsAnnotations

public java.util.List<java.lang.Class<? extends java.lang.annotation.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 java.util.List<java.lang.Class<? extends java.lang.annotation.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