Module io.smallrye.classfile

Package io.smallrye.classfile.extras.reflect

Enum Class AccessFlag.Location

java.lang.Object

java.lang.Enum<AccessFlag.Location>

io.smallrye.classfile.extras.reflect.AccessFlag.Location

All Implemented Interfaces:

Serializable, Comparable<AccessFlag.Location>, Constable

Enclosing class:

AccessFlag

public static enum AccessFlag.Location
extends Enum<AccessFlag.Location>

A location within a class file where flags can be applied.

Note that since these locations represent class file structures rather than language structures, many language structures, such as constructors and interfaces, are not present.

Since:

20

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLASS	Class location.
FIELD	Field location.
INNER_CLASS	Inner class location.
METHOD	Method location.
METHOD_PARAMETER	Method parameter location.
MODULE	Module location.
MODULE_EXPORTS	Module exports location.
MODULE_OPENS	Module opens location.
MODULE_REQUIRES	Module requires location.

Method Summary

Modifier and Type	Method	Description
Set<AccessFlag>	flags()	Returns the set of access flags defined for this location in the current class file format version.
Set<AccessFlag>	flags(ClassFileFormatVersion cffv)	Returns the set of access flags defined for this location in the given class file format version.
int	flagsMask()	Returns the union of masks of all access flags defined for this location in the current class file format version.
int	flagsMask(ClassFileFormatVersion cffv)	Returns the union of masks of all access flags defined for this location in the given class file format version.
static AccessFlag.Location	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AccessFlag.Location[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLASS

public static final AccessFlag.Location CLASS

Class location.

See Also:

• invalid reference

  Class#accessFlags()

• ClassModel.flags()
• Modifier.classModifiers()
• Modifier.interfaceModifiers()

FIELD

public static final AccessFlag.Location FIELD

Field location.

See Also:

• invalid reference

  Field#accessFlags()

• FieldModel.flags()
• Modifier.fieldModifiers()

METHOD

public static final AccessFlag.Location METHOD

Method location.

See Also:

• invalid reference

  Executable#accessFlags()

• MethodModel.flags()
• Modifier.methodModifiers()
• Modifier.constructorModifiers()

INNER_CLASS

public static final AccessFlag.Location INNER_CLASS

Inner class location.

See Also:

• invalid reference

  Class#accessFlags()

• InnerClassInfo.flags()
• Modifier.classModifiers()
• Modifier.interfaceModifiers()

METHOD_PARAMETER

public static final AccessFlag.Location METHOD_PARAMETER

Method parameter location.

See Also:

• invalid reference

  Parameter#accessFlags()

• MethodParameterInfo.flags()
• Modifier.parameterModifiers()

MODULE

public static final AccessFlag.Location MODULE

Module location.

See Also:

• invalid reference

  ModuleDescriptor#accessFlags()

• ModuleAttribute.moduleFlags()

MODULE_REQUIRES

public static final AccessFlag.Location MODULE_REQUIRES

Module requires location.

See Also:

• invalid reference

  ModuleDescriptor.Requires#accessFlags()

• ModuleRequireInfo.requiresFlags()

MODULE_EXPORTS

public static final AccessFlag.Location MODULE_EXPORTS

Module exports location.

See Also:

• invalid reference

  ModuleDescriptor.Exports#accessFlags()

• ModuleExportInfo.exportsFlags()

MODULE_OPENS

public static final AccessFlag.Location MODULE_OPENS

Module opens location.

See Also:

• invalid reference

  ModuleDescriptor.Opens#accessFlags()

• ModuleOpenInfo.opensFlags()

Method Details

values

public static AccessFlag.Location[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AccessFlag.Location valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

flagsMask

public int flagsMask()

Returns the union of masks of all access flags defined for this location in the current class file format version.

This method returns 0 if this location does not exist in the current class file format version.

Returns:

the union of masks of all access flags defined for this location in the current class file format version

Since:

25

flagsMask

public int flagsMask(ClassFileFormatVersion cffv)

Returns the union of masks of all access flags defined for this location in the given class file format version.

This method returns 0 if this location does not exist in the given cffv.

Parameters:

cffv - the class file format version

Returns:

the union of masks of all access flags defined for this location in the given class file format version

Throws:

NullPointerException - if cffv is null

Since:

25

flags

public Set<AccessFlag> flags()

Returns the set of access flags defined for this location in the current class file format version. The set is immutable.

This method returns an empty set if this location does not exist in the current class file format version.

Returns:

the set of access flags defined for this location in the current class file format version

Since:

25

flags

public Set<AccessFlag> flags(ClassFileFormatVersion cffv)

Returns the set of access flags defined for this location in the given class file format version. The set is immutable.

This method returns an empty set if this location does not exist in the given cffv.

Parameters:

cffv - the class file format version

Returns:

the set of access flags defined for this location in the given class file format version

Throws:

NullPointerException - if cffv is null

Since:

25