cascading.management.annotation
Enum Visibility
java.lang.Object
java.lang.Enum<Visibility>
cascading.management.annotation.Visibility
- All Implemented Interfaces:
- Serializable, Comparable<Visibility>
public enum Visibility
- extends Enum<Visibility>
Visibility controls whether a certain Property
is visible to a certain
audience.
PRIVATE
- recommended that only a developer or team/project member have access to the value
PROTECTED
- recommended for interested and authorized parties
PUBLIC
- recommended for use as general purpose information
All properties in Cascading using the Property
annotation are marked as
PRIVATE
.
Except for Tap.getIdentifier()
which defines the Sanitizer
implementation URISanitizer
which attempts to cleanse the URI identifier
for each of the above visibilities.
It is up to the implementation of a DocumentService
to interpret and use these
values.
Cascading does not enforce any restrictions related to the values, they are considered informative.
To prevent serialization of any value via the registered DocumentService
, do not
mark a field with the Property annotation, or configure the service appropriately.
Method Summary |
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. |
PRIVATE
public static final Visibility PRIVATE
PROTECTED
public static final Visibility PROTECTED
PUBLIC
public static final Visibility PUBLIC
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
Copyright © 2007-2015 Concurrent, Inc. All Rights Reserved.