com.yworks.yfiles.graphml

Class HandleDeserializationEventArgs

java.lang.Object

com.yworks.yfiles.graphml.HandleDeserializationEventArgs

All Implemented Interfaces:

IEventArgs

public final class HandleDeserializationEventArgs
extends Object
implements IEventArgs

The event arguments used by HandleDeserialization and HandleDeserialization to let registered deserialization code perform the deserialization.

If the event handler determines that it can deserialize the XmlNode, it should place the result into the Result property and thus mark the event as Handled.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
HandleDeserializationEventArgs(IParseContext context, Node xmlNode, Class targetType) Initializes a new instance of the HandleDeserializationEventArgs class.

Method Summary

Modifier and Type	Method and Description
IParseContext	getContext() Gets the context in which the XmlNode shall be deserialized.
Object	getResult() Holds the result of the deserialization, which is null initially.
Class	getTargetType() Gets the type of the resulting instance that is required by the requesting deserializer or null if the target type is not known in advance.
Node	getXmlNode() Gets the XML node that contains the data to deserialize.
boolean	isHandled() Gets a value indicating whether this HandleDeserializationEventArgs is handled.
void	setHandled(boolean value) Sets a value indicating whether this HandleDeserializationEventArgs is handled.
void	setResult(Object value) Holds the result of the deserialization, which is null initially.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HandleDeserializationEventArgs

public HandleDeserializationEventArgs(IParseContext context,
                                      Node xmlNode,
                                      Class targetType)

Initializes a new instance of the HandleDeserializationEventArgs class.

Parameters:

context - The context in which serialization should take place.

xmlNode - The XML element that contains the data to deserialize.

targetType - The required target type of the Result.

Method Detail

getContext

public final IParseContext getContext()

Gets the context in which the XmlNode shall be deserialized.

Returns:

The context.

getResult

public final Object getResult()

Holds the result of the deserialization, which is null initially.

Setting this property will automatically set the Handled property to true.

Throws:

IllegalArgumentException - If the value is not assignable to TargetType

Returns:

The Result.

See Also:

setResult(Object)

getTargetType

public final Class getTargetType()

Gets the type of the resulting instance that is required by the requesting deserializer or null if the target type is not known in advance.

Returns:

The type of the result.

See Also:

IParseContext.deserialize(Class, IParseContext, Node)

getXmlNode

public final Node getXmlNode()

Gets the XML node that contains the data to deserialize.

Returns:

The XML node.

isHandled

public final boolean isHandled()

Gets a value indicating whether this HandleDeserializationEventArgs is handled.

Setting this property to true indicates to the event source that the Result has been assigned and that the event should not be propagated to further listeners.

Returns:

true if this event has been handled; false otherwise.

See Also:

setHandled(boolean)

setHandled

public final void setHandled(boolean value)

Sets a value indicating whether this HandleDeserializationEventArgs is handled.

Setting this property to true indicates to the event source that the Result has been assigned and that the event should not be propagated to further listeners.

Parameters:

value - true if this event has been handled; false otherwise.

See Also:

isHandled()

setResult

public final void setResult(Object value)

Holds the result of the deserialization, which is null initially.

Setting this property will automatically set the Handled property to true.

Throws:

IllegalArgumentException - If the value is not assignable to TargetType

Parameters:

value - The Result to set.

See Also:

getResult()