Package org.eclipse.persistence.internal.oxm.record

Interface UnmarshalContext

All Known Implementing Classes:

ChoiceUnmarshalContext, ObjectUnmarshalContext, SequencedUnmarshalContext

public interface UnmarshalContext

The UnmarshalContext allows mappings to be unmarshalled differently depending on the type of object. An UnmarshalRecord maintains a reference to a single UnmarshalContext.

Method Summary

Modifier and Type	Method	Description
void	addAttributeValue(UnmarshalRecord unmarshalRecord, ContainerValue containerValue, Object value)	When a collection mapping is processed the UnmarshalContext is responsible for handling the values one at a time.
void	addAttributeValue(UnmarshalRecord unmarshalRecord, ContainerValue containerValue, Object value, Object collection)	When a collection mapping is processed the UnmarshalContext is responsible for handling the values one at a time.
void	characters(UnmarshalRecord unmarshalRecord)	An event indicating that characters has been called on the unmarshalRecord.
void	endElement(UnmarshalRecord unmarshalRecord)	An event indicating that endElement has been called on the unmarshalRecord.
void	reference(Reference reference)
void	setAttributeValue(UnmarshalRecord unmarshalRecord, Object value, Mapping mapping)	The UnmarshalContext is responsible for assigning values to the object being built.
void	startElement(UnmarshalRecord unmarshalRecord)	An event indicating that startElement has been called on the unmarshalRecord.
void	unmappedContent(UnmarshalRecord unmarshalRecord)	This method is called when unmapped content (XML content that does not correspond to any specified mapping, policy, etc.) is encountered during the unmarshal process.

Method Detail

startElement

void startElement(UnmarshalRecord unmarshalRecord)

An event indicating that startElement has been called on the unmarshalRecord.

Parameters:

unmarshalRecord - The UnmarshalRecord that received the startElement call.

characters

void characters(UnmarshalRecord unmarshalRecord)

An event indicating that characters has been called on the unmarshalRecord.

Parameters:

unmarshalRecord - The UnmarshalRecord that received the characters call.

endElement

void endElement(UnmarshalRecord unmarshalRecord)

An event indicating that endElement has been called on the unmarshalRecord.

Parameters:

unmarshalRecord - The UnmarshalRecord that received the endElement call.

setAttributeValue

void setAttributeValue(UnmarshalRecord unmarshalRecord,
                       Object value,
                       Mapping mapping)

The UnmarshalContext is responsible for assigning values to the object being built.

Parameters:

unmarshalRecord -

value -

mapping -

addAttributeValue

void addAttributeValue(UnmarshalRecord unmarshalRecord,
                       ContainerValue containerValue,
                       Object value)

When a collection mapping is processed the UnmarshalContext is responsible for handling the values one at a time.

Parameters:

unmarshalRecord -

containerValue - A container object such as a java.util.ArrayList, to which the value will be added.

value - The value to be added to the container,

addAttributeValue

void addAttributeValue(UnmarshalRecord unmarshalRecord,
                       ContainerValue containerValue,
                       Object value,
                       Object collection)

When a collection mapping is processed the UnmarshalContext is responsible for handling the values one at a time.

Parameters:

unmarshalRecord -

containerValue - A container object such as a java.util.ArrayList, to which the value will be added.

value - The value to be added to the container,

collection -

reference

void reference(Reference reference)

unmappedContent

void unmappedContent(UnmarshalRecord unmarshalRecord)

This method is called when unmapped content (XML content that does not correspond to any specified mapping, policy, etc.) is encountered during the unmarshal process.

Parameters:

unmarshalRecord - The UnmarshalRecord that encountered the unmapped content .