Enum Visibility
- All Implemented Interfaces:
Serializable, Comparable<Visibility>, java.lang.constant.Constable, 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 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 ConstantsEnum ConstantDescriptionModifier for a package-private visibility.A modifier contributor forprivatevisibility.A modifier contributor forprotectedvisibility.A modifier contributor forpublicvisibility. -
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.ForType
MASK -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateVisibility(int mask) Creates a new visibility representation. -
Method Summary
Modifier and TypeMethodDescriptionexpandTo(Visibility visibility) Expands the visibility to be at least as high as this visibility and the provided visibility.intgetMask()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 instance describes package-private visibility.booleanReturnstrueif this instance describesprivatevisibility.booleanReturnstrueif this instance describesprotectedvisibility.booleanisPublic()Returnstrueif this instance describespublicvisibility.static VisibilityReturns 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.
-
Enum Constant Details
-
PUBLIC
A modifier contributor forpublicvisibility. -
PACKAGE_PRIVATE
Modifier for a package-private visibility. (This is the default modifier.) -
PROTECTED
A modifier contributor forprotectedvisibility. -
PRIVATE
A modifier contributor forprivatevisibility.
-
-
Field Details
-
mask
private final int maskThe mask the modifier contributor.
-
-
Constructor Details
-
Visibility
private Visibility(int mask) Creates a new visibility representation.- Parameters:
mask- The modifier mask of this instance.
-
-
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.
-
isPublic
public boolean isPublic()Returnstrueif this instance describespublicvisibility.- Returns:
trueif this instance describespublicvisibility.
-
isProtected
public boolean isProtected()Returnstrueif this instance describesprotectedvisibility.- Returns:
trueif this instance describesprotectedvisibility.
-
isPackagePrivate
public boolean isPackagePrivate()Returnstrueif this instance describes package-private visibility.- Returns:
trueif this instance describes package-private visibility.
-
isPrivate
public boolean isPrivate()Returnstrueif this instance describesprivatevisibility.- Returns:
trueif this instance describesprivatevisibility.
-
expandTo
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.
-