com.luciad.format.xml.bind

LuciadLightspeedEnum ILcdXMLDocumentContext.Scope

java.lang.Object

java.lang.Enum<ILcdXMLDocumentContext.Scope>

com.luciad.format.xml.bind.ILcdXMLDocumentContext.Scope

All Implemented Interfaces:

Serializable, Comparable<ILcdXMLDocumentContext.Scope>

Enclosing interface:

ILcdXMLDocumentContext

public static enum ILcdXMLDocumentContext.Scope
extends Enum<ILcdXMLDocumentContext.Scope>

A type-safe enumeration, representing all possible scopes to be used in XML document contexts.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESCENDANTS The DESCENDANTS scope is to be used for variables that need only be accessible in the current XML element and all of its children.
GLOBAL The GLOBAL scope is to be used for variables that need to be accessible within the whole XML document.
LOCAL The LOCAL scope is to be used for variables that need only be accessible in the current XML element.

Method Summary

Modifier and Type	Method and Description
static ILcdXMLDocumentContext.Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ILcdXMLDocumentContext.Scope[]	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

GLOBAL

public static final ILcdXMLDocumentContext.Scope GLOBAL

The GLOBAL scope is to be used for variables that need to be accessible within the whole XML document. Setting a new value for the variable will permanently override. the old value. The variable will only be invalidated at the end of the decoding process, or if a null value is set for it.

DESCENDANTS

public static final ILcdXMLDocumentContext.Scope DESCENDANTS

The DESCENDANTS scope is to be used for variables that need only be accessible in the current XML element and all of its children. Setting a new value for the variable in one of the descendants, will override the old value for that descendant and all of its children. The variable will be invalidated when the element, in which the variable was set, is ended, or if a null value is set in that element. This scope works as a stack, where the actual value of the variable corresponds the value currently on top of the stack.

LOCAL

public static final ILcdXMLDocumentContext.Scope LOCAL

The LOCAL scope is to be used for variables that need only be accessible in the current XML element. Setting a new value for the variable in that element will permanently override the old value. The variable will be invalidated when the element, in which the variable was set, is ended, or if a null value is set in that element.

Method Detail

values

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

Returns:

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

valueOf

public static ILcdXMLDocumentContext.Scope 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