Enum Mandate
- All Implemented Interfaces:
Serializable, Comparable<Mandate>, java.lang.constant.Constable, ModifierContributor, ModifierContributor.ForField, ModifierContributor.ForMethod, ModifierContributor.ForParameter
public enum Mandate
extends Enum<Mandate>
implements ModifierContributor.ForField, ModifierContributor.ForMethod, ModifierContributor.ForParameter
Indicates if a member is mandated.
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E>Nested classes/interfaces inherited from interface ModifierContributor
ModifierContributor.ForField, ModifierContributor.ForMethod, ModifierContributor.ForModule, ModifierContributor.ForParameter, ModifierContributor.ForType, ModifierContributor.Resolver<T> -
Enum Constant Summary
Enum Constants -
Field Summary
FieldsFields inherited from interface ModifierContributor
EMPTY_MASKFields inherited from interface ModifierContributor.ForField
MASKFields inherited from interface ModifierContributor.ForMethod
MASKFields inherited from interface ModifierContributor.ForParameter
MASK -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintgetMask()Returns the mask of this modifier.intgetRange()Returns the entire range of modifiers that address this contributor's property.booleanDetermines if this is the default modifier.booleanReturnstrueif this state is mandated.static MandateReturns the enum constant of this type with the specified name.static Mandate[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
PLAIN
Modifier for a non-mandated member. (The default modifier.) -
MANDATED
Modifier for a mandated member.
-
-
Field Details
-
mask
private final int maskThe modifier mask for this mandate.
-
-
Constructor Details
-
Mandate
private Mandate(int mask) Creates a new mandate state.- Parameters:
mask- The modifier mask for this mandate.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getMask
public int getMask()Returns the mask of this modifier.- Specified by:
getMaskin interfaceModifierContributor- Returns:
- The modifier mask that is to be applied to the target type or type member.
-
getRange
public int getRange()Returns the entire range of modifiers that address this contributor's property.- Specified by:
getRangein interfaceModifierContributor- Returns:
- The range of this contributor's property.
-
isDefault
public boolean isDefault()Determines if this is the default modifier.- Specified by:
isDefaultin interfaceModifierContributor- Returns:
trueif this contributor represents the default modifier.
-
isMandated
public boolean isMandated()Returnstrueif this state is mandated.- Returns:
trueif this state is mandated.
-