Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.modeshape.sequencer.xml
Class XmlSequencer

    java.lang.Object
      org.modeshape.sequencer.xml.XmlSequencer

All Implemented Interfaces:
  StreamSequencer

Direct Known Subclasses:
  InheritingXmlSequencer

    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
`XmlSequencer()`

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

### XmlSequencer

    public XmlSequencer()

Method Detail

### setAttributeScoping

    public void setAttributeScoping(XmlSequencer.AttributeScoping scoping)

  Parameters:
    `scoping` - Sets scoping to the specified value.

### getAttributeScoping

    public XmlSequencer.AttributeScoping getAttributeScoping()

  Returns:
    scoping

### sequence

    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`
  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`
  See Also:
    `StreamSequencer.sequence(InputStream, SequencerOutput, StreamSequencerContext)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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