Visibility (Apache Juneau 7.1.1)

java.lang.Object
- java.lang.Enum<Visibility>
- - org.apache.juneau.Visibility

All Implemented Interfaces:

Serializable, Comparable<Visibility>
```
public enum Visibility
extends Enum<Visibility>
```
Defines class/field/method visibilities.
Used to specify minimum levels of visibility when detecting bean classes, methods, and fields.
Used in conjunction with the following bean context properties:

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DEFAULT` Include all but private classes/fields/methods.
`NONE` Ignore all
`PRIVATE` Include all classes/fields/methods.
`PROTECTED` Include only public or protected classes/fields/methods.
`PUBLIC` Include only public classes/fields/methods.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isVisible(Constructor<?> x)` Shortcut for `isVisible(x.getModifiers());`
`boolean`	`isVisible(Field x)` Shortcut for `isVisible(x.getModifiers());`
`boolean`	`isVisible(int mod)` Identifies if the specified mod matches this visibility.
`boolean`	`isVisible(Method x)` Shortcut for `isVisible(x.getModifiers());`
`static boolean`	`setAccessible(Constructor<?> x)` Attempts to call `x.setAccessible(true)` and quietly ignores security exceptions.
`static boolean`	`setAccessible(Field x)` Attempts to call `x.setAccessible(true)` and quietly ignores security exceptions.
`static boolean`	`setAccessible(Method x)` Attempts to call `x.setAccessible(true)` and quietly ignores security exceptions.
`<T> Constructor<T>`	`transform(Constructor<T> x)` Makes constructor accessible if it matches the visibility requirements, or returns null if it doesn't.
`Field`	`transform(Field x)` Makes field accessible if it matches the visibility requirements, or returns null if it doesn't.
`Method`	`transform(Method x)` Makes method accessible if it matches the visibility requirements, or returns null if it doesn't.
`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
  - NONE
```
public static final Visibility NONE
```
    Ignore all
  - PUBLIC
```
public static final Visibility PUBLIC
```
    Include only public classes/fields/methods.
  - PROTECTED
```
public static final Visibility PROTECTED
```
    Include only public or protected classes/fields/methods.
  - DEFAULT
```
public static final Visibility DEFAULT
```
    Include all but private classes/fields/methods.
  - PRIVATE
```
public static final Visibility PRIVATE
```
    Include all classes/fields/methods.
- 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
  - isVisible
```
public boolean isVisible(int mod)
```
    Identifies if the specified mod matches this visibility.
    Example:
    
    PUBLIC.isVisible(MyPublicClass.class.getModifiers()); //true PUBLIC.isVisible(MyPrivateClass.class.getModifiers()); //false PRIVATE.isVisible(MyPrivateClass.class.getModifiers()); //true NONE.isVisible(MyPublicClass.class.getModifiers()); //false
    
    Parameters:
    
    mod - The modifier from the object being tested (e.g. results from Class.getModifiers().
    
    Returns:
    
    true if this visibility matches the specified modifier attribute.
  - isVisible
```
public boolean isVisible(Constructor<?> x)
```
    Shortcut for isVisible(x.getModifiers());
    
    Parameters:
    
    x - The constructor to check.
    
    Returns:
    
    true if the constructor is at least as visible as this object.
  - isVisible
```
public boolean isVisible(Method x)
```
    Shortcut for isVisible(x.getModifiers());
    
    Parameters:
    
    x - The method to check.
    
    Returns:
    
    true if the method is at least as visible as this object.
  - isVisible
```
public boolean isVisible(Field x)
```
    Shortcut for isVisible(x.getModifiers());
    
    Parameters:
    
    x - The field to check.
    
    Returns:
    
    true if the field is at least as visible as this object.
  - transform
```
public <T> Constructor<T> transform(Constructor<T> x)
```
    Makes constructor accessible if it matches the visibility requirements, or returns null if it doesn't.
    Security exceptions thrown on the call to AccessibleObject.setAccessible(boolean) are quietly ignored.
    
    Parameters:
    
    x - The constructor.
    
    Returns:
    
    The same constructor if visibility requirements met, or null if visibility requirement not met or call to AccessibleObject.setAccessible(boolean) throws a security exception.
  - transform
```
public Method transform(Method x)
```
    Makes method accessible if it matches the visibility requirements, or returns null if it doesn't.
    Security exceptions thrown on the call to AccessibleObject.setAccessible(boolean) are quietly ignored.
    
    Parameters:
    
    x - The method.
    
    Returns:
    
    The same method if visibility requirements met, or null if visibility requirement not met or call to AccessibleObject.setAccessible(boolean) throws a security exception.
  - transform
```
public Field transform(Field x)
```
    Makes field accessible if it matches the visibility requirements, or returns null if it doesn't.
    Security exceptions thrown on the call to AccessibleObject.setAccessible(boolean) are quietly ignored.
    
    Parameters:
    
    x - The field.
    
    Returns:
    
    The same field if visibility requirements met, or null if visibility requirement not met or call to AccessibleObject.setAccessible(boolean) throws a security exception.
  - setAccessible
```
public static boolean setAccessible(Constructor<?> x)
```
    Attempts to call x.setAccessible(true) and quietly ignores security exceptions.
    
    Parameters:
    
    x - The constructor.
    
    Returns:
    
    true if call was successful.
  - setAccessible
```
public static boolean setAccessible(Method x)
```
    Attempts to call x.setAccessible(true) and quietly ignores security exceptions.
    
    Parameters:
    
    x - The method.
    
    Returns:
    
    true if call was successful.
  - setAccessible
```
public static boolean setAccessible(Field x)
```
    Attempts to call x.setAccessible(true) and quietly ignores security exceptions.
    
    Parameters:
    
    x - The field.
    
    Returns:
    
    true if call was successful.

Enum Visibility

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

PUBLIC

PROTECTED

DEFAULT

PRIVATE

Method Detail

values

valueOf

isVisible

Example:

isVisible

isVisible

isVisible

transform

transform

transform

setAccessible

setAccessible

setAccessible