com.yworks.yfiles.graphml

Class HandleSerializationEventArgs

java.lang.Object

com.yworks.yfiles.graphml.HandleSerializationEventArgs

All Implemented Interfaces:

IEventArgs

public final class HandleSerializationEventArgs
extends Object
implements IEventArgs

The event arguments used by HandleSerialization and HandleSerialization to let registered serialization code perform the serialization of items.

If the event handler determines that it can serialize the Item, it should use the Writer for output and mark the event as Handled so that other code will not perform serialization, too.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
HandleSerializationEventArgs(IWriteContext context, Object item) Initializes a new instance of the HandleSerializationEventArgs class using the provided context to write the item using the given type for serialization.
HandleSerializationEventArgs(IWriteContext context, Object item, Type serializationType) Initializes a new instance of the HandleSerializationEventArgs class using the provided context to write the item using the given type for serialization.

Method Summary

Modifier and Type	Method and Description
IWriteContext	getContext() Gets the context to be used for writing.
Object	getItem() Gets the item that should be serialized.
Type	getSourceType() Declares the type in the inheritance of the Item that should be used for serialization.
IXmlWriter	getWriter() Gets the writer for writing the xml output.
boolean	isHandled() Gets a value indicating whether this HandleSerializationEventArgs is handled.
void	replaceItem(Object item, Class serializationType) Replaces the Item using a substitute for serialization.
void	setHandled(boolean value) Sets a value indicating whether this HandleSerializationEventArgs is handled.

Methods inherited from class java.lang.Object

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

Constructor Detail

HandleSerializationEventArgs

public HandleSerializationEventArgs(IWriteContext context,
                                    Object item)

Initializes a new instance of the HandleSerializationEventArgs class using the provided context to write the item using the given type for serialization.

Parameters:

context - The context to use for writing.

item - The item to to serialize.

HandleSerializationEventArgs

public HandleSerializationEventArgs(IWriteContext context,
                                    Object item,
                                    Type serializationType)

Initializes a new instance of the HandleSerializationEventArgs class using the provided context to write the item using the given type for serialization.

Parameters:

context - The context to use for writing.

item - The item to to serialize.

serializationType - The type that should be used for serialization, which needs to be a super type or interface of the item or null.

Method Detail

getContext

public final IWriteContext getContext()

Gets the context to be used for writing.

Returns:

The context.

getItem

public final Object getItem()

Gets the item that should be serialized.

Returns:

The item.

getSourceType

public final Type getSourceType()

Declares the type in the inheritance of the Item that should be used for serialization.

Returns:

The type of the serialization or null if the type should be inferred from the Item.

getWriter

public final IXmlWriter getWriter()

Gets the writer for writing the xml output.

Returns:

The writer that writes the GraphML xml.

isHandled

public final boolean isHandled()

Gets a value indicating whether this HandleSerializationEventArgs is handled.

Setting this property to true indicates to the event source that the Item has been successfully serialized using the Writer and no other code needs to handle the serialization request, anymore.

Returns:

true if this event has been handled; false otherwise.

See Also:

setHandled(boolean)

replaceItem

public final void replaceItem(Object item,
                              Class serializationType)

Replaces the Item using a substitute for serialization.

This method can be used to replace the Item and SourceType property so that the serialization chain can be traversed with a substituted item. If this method has been called the Handled property should not be set to true.

Parameters:

item - The substitute to assign to the Item property.

serializationType - The serialization type to assign to the SourceType property.

setHandled

public final void setHandled(boolean value)

Sets a value indicating whether this HandleSerializationEventArgs is handled.

Setting this property to true indicates to the event source that the Item has been successfully serialized using the Writer and no other code needs to handle the serialization request, anymore.

Parameters:

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

See Also:

isHandled()