Top Description Inners Fields Constructors Methods

com.ctc.wstx.dtd

public final Class DefaultAttrValue

Class Inheritance

extends Object

java.lang.Object
com.ctc.wstx.dtd.DefaultAttrValue

Imports

java.text.MessageFormat, javax.xml.stream.Location, .XMLStreamException, org.codehaus.stax2.validation.ValidationContext, .XMLValidationProblem, .XMLValidator, com.ctc.wstx.cfg.ErrorConsts

Simple container class used to contain information about the default value for an attribute. Although for most use cases a simple String would suffice, there are cases where additional information is needed (especially status of 'broken' default values, which only need to be reported should the default value be needed).

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	DefaultAttrValue.UndeclaredEntity

Field Summary

Modifier and Type	Field and Description
public static final int	DEF_DEFAULT
public static final int	DEF_FIXED
public static final int	DEF_IMPLIED
public static final int	DEF_REQUIRED
pack-priv final int	mDefValueType
private DefaultAttrValue.UndeclaredEntity	mUndeclaredEntity For now, let's only keep track of the first undeclared entity: can be extended if necessary.
private String	mValue Actual expanded textual content of the default attribute value; normalized if appropriate in this mode.
pack-priv static final DefaultAttrValue	sImplied
pack-priv static final DefaultAttrValue	sRequired

Constructor Summary

Access	Constructor and Description
private	DefaultAttrValue(int defValueType)

Method Summary

Modifier and Type	Method and Description
private void	addUndeclaredEntity(String name, Location loc, boolean isPe)
public void	addUndeclaredGE(String name, Location loc)
public void	addUndeclaredPE(String name, Location loc)
public static DefaultAttrValue	constructFixed()
public static DefaultAttrValue	constructImplied()
public static DefaultAttrValue	constructOptional()
public static DefaultAttrValue	constructRequired()
public String	getValue()
public String	Returns: Expanded default value String, if there were no problems (no undeclared entities), or null to indicate there were problems. In latter case, caller is to figure out exact type of the problem and report this appropriately to the application. getValueIfOk()
public boolean	hasDefaultValue()
public boolean	hasUndeclaredEntities()
public boolean	isFixed()
public boolean	isRequired()
public boolean	isSpecial() Method used by the element to figure out if attribute needs "special" checking; basically if it's required, and/or has a default value.
public void	reportUndeclared(ValidationContext ctxt, XMLValidator dtd)
public void	setValue(String v)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEF_DEFAULT	back to summary
public static final int DEF_DEFAULT

DEF_FIXED	back to summary
public static final int DEF_FIXED

DEF_IMPLIED	back to summary
public static final int DEF_IMPLIED

DEF_REQUIRED	back to summary
public static final int DEF_REQUIRED

mDefValueType	back to summary
pack-priv final int mDefValueType

mUndeclaredEntity	back to summary
private DefaultAttrValue.UndeclaredEntity mUndeclaredEntity For now, let's only keep track of the first undeclared entity: can be extended if necessary.

mValue	back to summary
private String mValue Actual expanded textual content of the default attribute value; normalized if appropriate in this mode. Note that all entities have been expanded: if a GE/PE was undefined, and no fatal errors were reported (non-validating mode), the references were just silently removed, and matching entries added to `mUndeclaredEntity`

sImplied	back to summary
pack-priv static final DefaultAttrValue sImplied

sRequired	back to summary
pack-priv static final DefaultAttrValue sRequired

Constructor Detail

DefaultAttrValue	back to summary
private DefaultAttrValue(int defValueType)

Method Detail

addUndeclaredEntity	back to summary
private void addUndeclaredEntity(String name, Location loc, boolean isPe)

addUndeclaredGE	back to summary
public void addUndeclaredGE(String name, Location loc)

addUndeclaredPE	back to summary
public void addUndeclaredPE(String name, Location loc)

constructFixed	back to summary
public static DefaultAttrValue constructFixed()

constructImplied	back to summary
public static DefaultAttrValue constructImplied()

constructOptional	back to summary
public static DefaultAttrValue constructOptional()

constructRequired	back to summary
public static DefaultAttrValue constructRequired()

getValue	back to summary
public String getValue()

getValueIfOk	back to summary
public String getValueIfOk() Returns:String Expanded default value String, if there were no problems (no undeclared entities), or null to indicate there were problems. In latter case, caller is to figure out exact type of the problem and report this appropriately to the application.

hasDefaultValue	back to summary
public boolean hasDefaultValue()

hasUndeclaredEntities	back to summary
public boolean hasUndeclaredEntities()

isFixed	back to summary
public boolean isFixed()

isRequired	back to summary
public boolean isRequired()

isSpecial	back to summary
public boolean isSpecial() Method used by the element to figure out if attribute needs "special" checking; basically if it's required, and/or has a default value. In both cases missing the attribute has specific consequences, either exception or addition of a default value.

reportUndeclared	back to summary
public void reportUndeclared(ValidationContext ctxt, XMLValidator dtd) throws XMLStreamException

setValue	back to summary
public void setValue(String v)

com.ctc.wstx.dtd back to summary

pack-priv final Class DefaultAttrValue.UndeclaredEntity

Class Inheritance

extends Object

java.lang.Object
com.ctc.wstx.dtd.DefaultAttrValue.UndeclaredEntity

Field Summary

Modifier and Type	Field and Description
pack-priv final boolean	mIsPe
pack-priv final Location	mLocation
pack-priv final String	mName

Constructor Summary

Access	Constructor and Description
pack-priv	UndeclaredEntity(String name, Location loc, boolean isPe)

Method Summary

Modifier and Type	Method and Description
public void	reportUndeclared(ValidationContext ctxt, XMLValidator dtd)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

mIsPe	back to summary
pack-priv final boolean mIsPe

mLocation	back to summary
pack-priv final Location mLocation

mName	back to summary
pack-priv final String mName

Constructor Detail

UndeclaredEntity	back to summary
pack-priv UndeclaredEntity(String name, Location loc, boolean isPe)

Method Detail

reportUndeclared	back to summary
public void reportUndeclared(ValidationContext ctxt, XMLValidator dtd) throws XMLStreamException