Top Description Fields Constructors Methods
com.ctc.wstx.dtd

pack-priv final Class DTDWriter

extends Object
Class Inheritance
Imports
java.io.IOException, .Writer, javax.xml.stream.XMLStreamException, com.ctc.wstx.exc.WstxIOException

Simple utility class used by DTDReader when writing out flattened external DTD subset file. Writing functionality encapsulated here since it's specific to one mode of operation (flattening).

Note, too, that underlying IOExceptions are generally wrapped as XMLStreamExceptions. This is needed to reduce amount of work caller has to do for wrapping. It will still be possible to unwrap these exceptions further up the call stack if need be.

Field Summary

Modifier and TypeField and Description
pack-priv int
mFlattenStart

Pointer to first character in the current input buffer that has not yet been written to flatten writer.

pack-priv final boolean
pack-priv final boolean
pack-priv final boolean
pack-priv int
mIsFlattening

Counter that indicates whether flattened output should be written to (non-null) mWriter; values above zero indicate output is enabled, zero and below that output is disabled.

pack-priv final Writer

Constructor Summary

AccessConstructor and Description
public
DTDWriter(Writer out, boolean inclComments, boolean inclCond, boolean inclPEs)

Method Summary

Modifier and TypeMethod and Description
public void
public void
enableOutput(int newStart)

public void
flush(char[] buf, int upUntil)

public int
public boolean
public boolean
public boolean
public void
output(String output)

Method called when explicit output has to be done for flatten output: this is usually done when there's need to do speculative checks before it's known if some chars are output (when suppressing comments or conditional sections)

public void
output(char c)

public void
setFlattenStart(int ptr)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

mFlattenStartback to summary
pack-priv int mFlattenStart

Pointer to first character in the current input buffer that has not yet been written to flatten writer.

mIncludeCommentsback to summary
pack-priv final boolean mIncludeComments
mIncludeConditionalsback to summary
pack-priv final boolean mIncludeConditionals
mIncludePEsback to summary
pack-priv final boolean mIncludePEs
mIsFlatteningback to summary
pack-priv int mIsFlattening

Counter that indicates whether flattened output should be written to (non-null) mWriter; values above zero indicate output is enabled, zero and below that output is disabled. Only enabled if mWriter is not null; will be temporarily disabled during processing of content that is not to be included (PE reference; or comments / conditional sections if comment/cs output is suppressed)

mWriterback to summary
pack-priv final Writer mWriter

Constructor Detail

DTDWriterback to summary
public DTDWriter(Writer out, boolean inclComments, boolean inclCond, boolean inclPEs)

Method Detail

disableOutputback to summary
public void disableOutput()
enableOutputback to summary
public void enableOutput(int newStart)
flushback to summary
public void flush(char[] buf, int upUntil) throws XMLStreamException
getFlattenStartback to summary
public int getFlattenStart()
includeCommentsback to summary
public boolean includeComments()
includeConditionalsback to summary
public boolean includeConditionals()
includeParamEntitiesback to summary
public boolean includeParamEntities()
outputback to summary
public void output(String output) throws XMLStreamException

Method called when explicit output has to be done for flatten output: this is usually done when there's need to do speculative checks before it's known if some chars are output (when suppressing comments or conditional sections)

outputback to summary
public void output(char c) throws XMLStreamException
setFlattenStartback to summary
public void setFlattenStart(int ptr)