java.lang.Object
com.github.rvesse.airline.model.OptionMetadata
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
private final String
private final boolean
private final OptionType
private final boolean
private final TypeConverterProvider
private final List
<OptionRestriction> private final boolean
-
Constructor Summary
ConstructorsConstructorDescriptionOptionMetadata
(OptionType optionType, Iterable<String> options, Iterable<String> titles, String description, int arity, boolean hidden, boolean overrides, boolean sealed, Iterable<OptionRestriction> restrictions, TypeConverterProvider typeConverterProvider, Iterable<Field> path) OptionMetadata
(Iterable<OptionMetadata> options) -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
getArity()
Class
<?> getTitle()
Deprecated.getTitle
(int index) int
hashCode()
boolean
isHidden()
boolean
boolean
boolean
boolean
isSealed()
static OptionMetadata
override
(Set<String> names, OptionMetadata parent, OptionMetadata child) Tries to merge the option metadata together such that the child metadata takes precedence.toString()
-
Field Details
-
optionType
-
options
-
titles
-
description
-
arity
private final int arity -
overrides
private final boolean overrides -
sealed
private final boolean sealed -
restrictions
-
provider
-
accessors
-
-
Constructor Details
-
OptionMetadata
public OptionMetadata(OptionType optionType, Iterable<String> options, Iterable<String> titles, String description, int arity, boolean hidden, boolean overrides, boolean sealed, Iterable<OptionRestriction> restrictions, TypeConverterProvider typeConverterProvider, Iterable<Field> path) -
OptionMetadata
-
-
Method Details
-
getOptionType
-
getOptions
-
getTitles
-
getTitle
Deprecated.Options now support multiple titles, usegetTitle(int)
to get a specific title orgetTitles()
to get all titlesGets the first title- Returns:
- First title
-
getTitle
-
getDescription
-
getArity
public int getArity() -
isRequired
public boolean isRequired() -
isHidden
public boolean isHidden() -
isOverride
public boolean isOverride() -
isSealed
public boolean isSealed() -
isMultiValued
public boolean isMultiValued() -
getJavaType
-
getAccessors
-
getRestrictions
-
getTypeConverterProvider
-
equals
-
hashCode
public int hashCode() -
toString
-
override
public static OptionMetadata override(Set<String> names, OptionMetadata parent, OptionMetadata child) Tries to merge the option metadata together such that the child metadata takes precedence. Not all options can be successfully overridden and an error may be thrown in cases where merging is not possibleThe following pieces of metadata may be overridden:
- Title
- Description
- Required
- Hidden
- Parameters:
parent
- Parentchild
- Child- Returns:
- Merged metadata
-
getTitle(int)
to get a specific title orgetTitles()
to get all titles