com.espertech.esper.common.client.util

Enum NameAccessModifier

java.lang.Object

java.lang.Enum<NameAccessModifier>

com.espertech.esper.common.client.util.NameAccessModifier

All Implemented Interfaces:

Serializable, Comparable<NameAccessModifier>

public enum NameAccessModifier
extends Enum<NameAccessModifier>

Visibility modifiers for EPL objects.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PRECONFIGURED Preconfigured is used for objects that are preconfigured by configuration.
PRIVATE Private is used for objects that may be used with the same module.
PROTECTED Protected is used for objects that may be used with the modules of the same module name.
PUBLIC Public is used for objects that may be used by other modules irrespective of module names.
TRANSIENT Transient is used for non-visible objects that are only visible for the purpose of statement-internal processing.

Method Summary

Modifier and Type	Method and Description
boolean	isModuleProvidedAccessModifier() Returns true if the modifier can be used by modules i.e.
boolean	isNonPrivateNonTransient() Returns true for a public and protected and false for all others
boolean	isPrivateOrTransient() Returns true for a private and transient and false for all others
static NameAccessModifier	valueOf(String name) Returns the enum constant of this type with the specified name.
static NameAccessModifier[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static boolean	visible(NameAccessModifier objectVisibility, String objectModuleName, String importModuleName) Returns indicator whether the object is visible.

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

TRANSIENT

public static final NameAccessModifier TRANSIENT

Transient is used for non-visible objects that are only visible for the purpose of statement-internal processing.

PRIVATE

public static final NameAccessModifier PRIVATE

Private is used for objects that may be used with the same module.

PROTECTED

public static final NameAccessModifier PROTECTED

Protected is used for objects that may be used with the modules of the same module name.

PUBLIC

public static final NameAccessModifier PUBLIC

Public is used for objects that may be used by other modules irrespective of module names.

PRECONFIGURED

public static final NameAccessModifier PRECONFIGURED

Preconfigured is used for objects that are preconfigured by configuration.

Method Detail

values

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

Returns:

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

valueOf

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

visible

public static boolean visible(NameAccessModifier objectVisibility,
                              String objectModuleName,
                              String importModuleName)

Returns indicator whether the object is visible.

Always false if the object is private or transient.

Always true if the object is public or preconfigured.

For protected the module name must match

Parameters:

objectVisibility - object visibility

objectModuleName - object module name

importModuleName - my module name

Returns:

indicator

isModuleProvidedAccessModifier

public boolean isModuleProvidedAccessModifier()

Returns true if the modifier can be used by modules i.e. returns true for private, protected and public. Returns false for preconfigured since preconfigured is reserved for configured objects. Returns false for transient as transient is reserved for internal use

Returns:

indicator

isNonPrivateNonTransient

public boolean isNonPrivateNonTransient()

Returns true for a public and protected and false for all others

Returns:

indicator

isPrivateOrTransient

public boolean isPrivateOrTransient()

Returns true for a private and transient and false for all others

Returns:

indicator