com.luciad.format.xml.bind

LuciadLightspeedInterface ILcdXMLDocumentContext

public interface ILcdXMLDocumentContext

Interface for accessing the context of an XML document being decoded. This context allows to store and retrieve variables during the decoding of an XML document. Each value is stored using a key (to identify the variable), and a scope (to indicate which other unmarshallers or marshallers should be able to access the value).

An ILcdXMLDocumentContext is created per document by the XML context.

Users should not implement this interface.

Since:

9.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILcdXMLDocumentContext.Scope A type-safe enumeration, representing all possible scopes to be used in XML document contexts.

Method Summary

Modifier and Type	Method and Description
Object	get(Object aKey, ILcdXMLDocumentContext.Scope aScope) Retrieves an object in the document context.
void	put(Object aKey, ILcdXMLDocumentContext.Scope aScope, Object aValue) Stores an object in the document context.

Method Detail

put

void put(Object aKey,
         ILcdXMLDocumentContext.Scope aScope,
         Object aValue)

Stores an object in the document context.

Parameters:

aKey - the key, used to identify the object.

aValue - the object to be stored.

aScope - the scope, in which the object should be visible.

Throws:

NullPointerException - if aKey</code> or <code>aScope</code> is <code>null.

get

Object get(Object aKey,
           ILcdXMLDocumentContext.Scope aScope)

Retrieves an object in the document context.

Parameters:

aKey - the key, used to identify the object.

aScope - the scope in which the object is stored.

Returns:

the object with the given key and scope, or null if no object was stored yet.

Throws:

NullPointerException - if aKey</code> or <code>aScope</code> is <code>null.