Class XmlSequencer

  extended by org.modeshape.sequencer.xml.XmlSequencer
All Implemented Interfaces:
Direct Known Subclasses:

public class XmlSequencer
extends Object
implements StreamSequencer

A sequencer for XML files, which maintains DTD, entity, comments, and other content. Note that by default the sequencer uses the default namespace for unqualified attribute rather than inheriting the namespace from the element. (See also InheritingXmlSequencer.

Nested Class Summary
static class XmlSequencer.AttributeScoping
          The choices for how attributes that have no namespace prefix should be assigned a namespace.
Constructor Summary
Method Summary
 XmlSequencer.AttributeScoping getAttributeScoping()
 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 setAttributeScoping(XmlSequencer.AttributeScoping scoping)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public XmlSequencer()
Method Detail


public void setAttributeScoping(XmlSequencer.AttributeScoping scoping)
scoping - Sets scoping to the specified value.


public XmlSequencer.AttributeScoping getAttributeScoping()


public void sequence(InputStream stream,
                     SequencerOutput output,
                     StreamSequencerContext context)
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
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
See Also:
StreamSequencer.sequence(InputStream, SequencerOutput, StreamSequencerContext)

Copyright © 2008-2010 JBoss, a division of Red Hat. All Rights Reserved.