org.modeshape.sequencer.classfile
Class ClassFileSequencer

java.lang.Object
  org.modeshape.sequencer.classfile.ClassFileSequencer

All Implemented Interfaces:

StreamSequencer

@ThreadSafe
public class ClassFileSequencer
extends Object
implements StreamSequencer

Constructor Summary

ClassFileSequencer()

Method Summary

void	sequence(InputStream stream, SequencerOutput output, StreamSequencerContext context) Sequence the data found in the supplied stream, placing the output information into the supplied map.
void	setClassFileRecorder(ClassFileRecorder classFileRecorder) Sets a custom ClassFileRecorder.
void	setClassFileRecorderClassName(String classFileRecorderClassName) Sets the custom ClassFileRecorder by specifying a class name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassFileSequencer

public ClassFileSequencer()

Method Detail

sequence

public void sequence(InputStream stream,
                     SequencerOutput output,
                     StreamSequencerContext context)

Description copied from interface: StreamSequencer

Sequence the data found in the supplied stream, placing the output information into the supplied map.

ModeShape's SequencingService determines the sequencers that should be executed by monitoring the changes to one or more workspaces that it is monitoring. Changes in those workspaces are aggregated and used to determine which sequencers should be called. If the sequencer implements this interface, then this method is called with the property that is to be sequenced along with the interface used to register the output. The framework takes care of all the rest.

Specified by:

sequence in interface StreamSequencer

Parameters:

stream - the stream with the data to be sequenced; never null

output - the output from the sequencing operation; never null

context - the context for the sequencing operation; never null

setClassFileRecorderClassName

public void setClassFileRecorderClassName(String classFileRecorderClassName)
                                   throws ClassNotFoundException,
                                          IllegalAccessException,
                                          InstantiationException

Sets the custom 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.

Parameters:

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.

Throws:

ClassNotFoundException - if the the class for the ClassFileRecorder implementation cannot be located

IllegalAccessException - 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 interface

setClassFileRecorder

public void setClassFileRecorder(ClassFileRecorder classFileRecorder)

Sets a custom ClassFileRecorder. If classFileRecorder is null, then the default class file recorder will be used.

Parameters:

classFileRecorder - the new custom class file recorder implementation; null indicates that the default class file recorder should be used.