net.bytebuddy.description.modifier

Enum ProvisioningState

java.lang.Object

java.lang.Enum<ProvisioningState>

net.bytebuddy.description.modifier.ProvisioningState

All Implemented Interfaces:

Serializable, Comparable<ProvisioningState>, ModifierContributor, ModifierContributor.ForParameter

public enum ProvisioningState
extends Enum<ProvisioningState>
implements ModifierContributor.ForParameter

Describes if a method parameter is mandated, i.e. not explicitly specified in the source code.

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.description.modifier.ModifierContributor

ModifierContributor.ForField, ModifierContributor.ForMethod, ModifierContributor.ForParameter, ModifierContributor.ForType

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANDATED Defines a parameter to be mandated.
PLAIN Defines a parameter to not be mandated.

Field Summary

Fields inherited from interface net.bytebuddy.description.modifier.ModifierContributor

EMPTY_MASK

Method Summary

Modifier and Type	Method and Description
int	getMask() Returns the mask of this modifier.
int	getRange() Returns the entire range of modifiers that address this contributor's property.
static ProvisioningState	is(boolean mandated) Creates a new provisioning state from a boolean value which indicates if the returned state should represent a final modifier.
boolean	isDefault() Determines if this is the default modifier.
boolean	isMandated() Checks if this instance represents a mandated parameter or not.
String	toString()
static ProvisioningState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProvisioningState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLAIN

public static final ProvisioningState PLAIN

Defines a parameter to not be mandated. (This is the default modifier.)

MANDATED

public static final ProvisioningState MANDATED

Defines a parameter to be mandated.

Method Detail

values

public static ProvisioningState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProvisioningState c : ProvisioningState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProvisioningState valueOf(String name)

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 name

NullPointerException - if the argument is null

is

public static ProvisioningState is(boolean mandated)

Creates a new provisioning state from a boolean value which indicates if the returned state should represent a final modifier.

Parameters:

mandated - true if the returned state should indicate a mandated parameter.

Returns:

A corresponding provisioning state.

getMask

public int getMask()

Description copied from interface: ModifierContributor

Returns the mask of this modifier.

Specified by:

getMask in interface ModifierContributor

Returns:

The modifier mask that is to be applied to the target type or type member.

getRange

public int getRange()

Description copied from interface: ModifierContributor

Returns the entire range of modifiers that address this contributor's property.

Specified by:

getRange in interface ModifierContributor

Returns:

The range of this contributor's property.

isDefault

public boolean isDefault()

Description copied from interface: ModifierContributor

Determines if this is the default modifier.

Specified by:

isDefault in interface ModifierContributor

Returns:

true if this contributor represents the default modifier.

isMandated

public boolean isMandated()

Checks if this instance represents a mandated parameter or not.

Returns:

true if this instance represents a mandated parameter.

toString

public String toString()

Overrides:

toString in class Enum<ProvisioningState>