@ThreadSafe public class ClassFileSequencer extends Sequencer
Sequencer.Context
Constructor and Description |
---|
ClassFileSequencer() |
Modifier and Type | Method and Description |
---|---|
boolean |
execute(Property inputProperty,
Node outputNode,
Sequencer.Context context)
Execute the sequencing operation on the specified property, which has recently been created or changed.
|
void |
initialize(NamespaceRegistry registry,
NodeTypeManager nodeTypeManager)
Initialize the sequencer.
|
void |
setClassFileRecorder(ClassFileRecorder classFileRecorder)
Sets a custom
ClassFileRecorder . |
void |
setClassFileRecorderClassName(String classFileRecorderClassName)
Sets the custom
ClassFileRecorder by specifying a class name. |
getAcceptedMimeTypes, getLogger, getName, getPathExpressions, getRepositoryName, getUniqueId, hasAcceptedMimeTypes, isAccepted, registerDefaultMimeTypes, registerNamespace, registerNodeTypes, registerNodeTypes, toString
public boolean execute(Property inputProperty, Node outputNode, Sequencer.Context context) throws Exception
Sequencer
Each sequencer is expected to process the value of the property, extract information from the value, and write a structured representation (in the form of a node or a subgraph of nodes) using the supplied output node. Note that the output node will either be:
Node.setPrimaryType(String)
)The implementation is expected to always clean up all resources that it acquired, even in the case of exceptions.
Note: This method must be threadsafe: ModeShape will likely invoke this method concurrently in separate threads,
and the method should never modify the state or fields of the Sequencer implementation class. All initialization should be
performed in Sequencer.initialize(NamespaceRegistry, NodeTypeManager)
.
execute
in class Sequencer
inputProperty
- the property that was changed and that should be used as the input; never nulloutputNode
- the node that represents the output for the derived information; never null, and will either be
new
if the output is being placed outside of the selected node, or will not be new when the
output is to be placed on the selected input nodecontext
- the context in which this sequencer is executing, and which may contain additional parameters useful when
generating the output structure; never nullException
- if there was a problem with the sequencer that could not be handled. All exceptions will be logged
automatically as errors by ModeShape.public void initialize(NamespaceRegistry registry, NodeTypeManager nodeTypeManager) throws RepositoryException, IOException
Sequencer
By default this method does nothing, so it should be overridden by implementations to do a one-time initialization of any
internal components. For example, sequencers can use the supplied registry
and nodeTypeManager
objects to register custom namesapces and node types required by the generated content.
initialize
in class Sequencer
registry
- the namespace registry that can be used to register custom namespaces; never nullnodeTypeManager
- the node type manager that can be used to register custom node types; never nullRepositoryException
- if operations on the NamespaceRegistry
or NodeTypeManager
failIOException
- if any stream based operations fail (like importing cnd files)public void setClassFileRecorderClassName(String classFileRecorderClassName) throws ClassNotFoundException, IllegalAccessException, InstantiationException
ClassFileRecorder
by specifying a class name. This method attempts to instantiate an instance of
the custom ClassFileRecorder
class prior to ensure that the new value represents a valid implementation.classFileRecorderClassName
- the fully-qualified class name of the new custom class file recorder implementation; null
indicates that the default class file recorder
should be used.ClassNotFoundException
- if the the class for the ClassFileRecorder
implementation cannot be locatedIllegalAccessException
- if the row factory class or its nullary constructor is not accessible.InstantiationException
- if the row factory represents an abstract class, an interface, an array class, a primitive
type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.ClassCastException
- if the instantiated class file recorder does not implement the ClassFileRecorder
interfacepublic void setClassFileRecorder(ClassFileRecorder classFileRecorder)
ClassFileRecorder
. If classFileRecorder
is null, then the default class file recorder
will be used.classFileRecorder
- the new custom class file recorder implementation; null indicates that
the default class file recorder
should be used.Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.