net.bytebuddy.description.modifier

Enum Visibility

java.lang.Object

java.lang.Enum<Visibility>

net.bytebuddy.description.modifier.Visibility

All Implemented Interfaces:

Serializable, Comparable<Visibility>, ModifierContributor, ModifierContributor.ForField, ModifierContributor.ForMethod, ModifierContributor.ForType

public enum Visibility
extends Enum<Visibility>
implements ModifierContributor.ForType, ModifierContributor.ForMethod, ModifierContributor.ForField

Describes a type's, field's or a method's visibility.

Nested Class Summary

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

ModifierContributor.ForField, ModifierContributor.ForMethod, ModifierContributor.ForParameter, ModifierContributor.ForType, ModifierContributor.Resolver<T extends ModifierContributor>

Enum Constant Summary

Enum Constants

Enum Constant and Description
PACKAGE_PRIVATE Modifier for a package-private visibility.
PRIVATE A modifier contributor for private visibility.
PROTECTED A modifier contributor for protected visibility.
PUBLIC A modifier contributor for public visibility.

Field Summary

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

MASK

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

MASK

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

MASK

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

EMPTY_MASK

Method Summary

Modifier and Type	Method and Description
Visibility	expandTo(Visibility visibility) Expands the visibility to be at least as high as this visibility and the provided visibility.
int	getMask() Returns the mask of this modifier.
int	getRange() Returns the entire range of modifiers that address this contributor's property.
boolean	isDefault() Determines if this is the default modifier.
boolean	isPackagePrivate() Returns true if this instance describes package-private visibility.
boolean	isPrivate() Returns true if this instance describes private visibility.
boolean	isProtected() Returns true if this instance describes protected visibility.
boolean	isPublic() Returns true if this instance describes public visibility.
static Visibility	valueOf(String name) Returns the enum constant of this type with the specified name.
static Visibility[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PUBLIC

public static final Visibility PUBLIC

A modifier contributor for public visibility.

PACKAGE_PRIVATE

public static final Visibility PACKAGE_PRIVATE

Modifier for a package-private visibility. (This is the default modifier.)

PROTECTED

public static final Visibility PROTECTED

A modifier contributor for protected visibility.

PRIVATE

public static final Visibility PRIVATE

A modifier contributor for private visibility.

Method Detail

values

public static Visibility[] 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 (Visibility c : Visibility.values())
    System.out.println(c);

Returns:

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

valueOf

public static Visibility 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

getMask

public int getMask()

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()

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()

Determines if this is the default modifier.

Specified by:

isDefault in interface ModifierContributor

Returns:

true if this contributor represents the default modifier.

isPublic

public boolean isPublic()

Returns true if this instance describes public visibility.

Returns:

true if this instance describes public visibility.

isProtected

public boolean isProtected()

Returns true if this instance describes protected visibility.

Returns:

true if this instance describes protected visibility.

isPackagePrivate

public boolean isPackagePrivate()

Returns true if this instance describes package-private visibility.

Returns:

true if this instance describes package-private visibility.

isPrivate

public boolean isPrivate()

Returns true if this instance describes private visibility.

Returns:

true if this instance describes private visibility.

expandTo

public Visibility expandTo(Visibility visibility)

Expands the visibility to be at least as high as this visibility and the provided visibility.

Parameters:

visibility - A visibility to compare against.

Returns:

A visibility that is as least as high as this and the supplied visibility.