Search this API

y.io.graphml.output
Class QueryOutputHandlersEvent

java.lang.Object
  extended by java.util.EventObject
      extended by y.io.graphml.output.QueryOutputHandlersEvent
All Implemented Interfaces:
java.io.Serializable

public final class QueryOutputHandlersEvent
extends java.util.EventObject

Event argument implementation that is used by the GraphMLHandler.fireQueryOutputHandlersEvent(QueryOutputHandlersEvent) event.

These event arguments can be used to addOutputHandler(y.io.graphml.output.OutputHandler,y.io.graphml.KeyScope) OutputHandler implementations to the GraphMLWriter dynamically at the time of writing.

See Also:
GraphMLHandler, Serialized Form
 
Your browser does not support SVG content.

Nested Class Summary
static class QueryOutputHandlersEvent.HandlerStruct
          Helper class that represents an OutputHandler that is bound to a certain scope.
 
Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
QueryOutputHandlersEvent(java.lang.Object source, GraphMLWriteContext context, java.util.List handlers)
          Initializes a new instance of the QueryOutputHandlersEvent class.
 
Method Summary
 void addOutputHandler(OutputHandler handler, KeyScope scope)
          Adds the given output handler to the set of registered output handlers for the given scope.
 GraphMLWriteContext getContext()
          Gets the context for which the handlers are queried.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QueryOutputHandlersEvent

public QueryOutputHandlersEvent(java.lang.Object source,
                                GraphMLWriteContext context,
                                java.util.List handlers)
Initializes a new instance of the QueryOutputHandlersEvent class.

Parameters:
source - The origin of the event
context - The context to assign to the getContext() property.
handlers - The list of handlers to which the addOutputHandler(y.io.graphml.output.OutputHandler,y.io.graphml.KeyScope) method will add the added instances.
Method Detail

addOutputHandler

public void addOutputHandler(OutputHandler handler,
                             KeyScope scope)
Adds the given output handler to the set of registered output handlers for the given scope.

Parameters:
handler - The handler to add.
scope - The scope to use for the handler.

getContext

public GraphMLWriteContext getContext()
Gets the context for which the handlers are queried.

Returns:
The context of the query.

© Copyright 2000-2022,
yWorks GmbH.
All rights reserved.