Modifier and Type	Class and Description
public static enum	OutputElement.PrefixState

Modifier and Type	Field and Description
private String	_defaultNsURI Namespace context end application may have supplied, and that (if given) should be used to augment explicitly defined bindings.
private WName	_name Prefixed name used for serialization.
private NsBinder	_nsBinder
private OutputElement	_parent Reference to either the parent (enclosing element) of this element, when part of active output context; or link to next reusable unused element after this one (if not part of active context).
private String	_uri Namespace of the element, whatever prefix part of `_name` maps to.
pack-priv static final byte	BYTE_GT
pack-priv static final byte	BYTE_LT
pack-priv static final byte	BYTE_SLASH

Access	Constructor and Description
private	OutputElement()
private	OutputElement(OutputElement parent, WName name, String uri, NsBinder binder)

Method Summary

Modifier and Type	Method and Description
public void	addPrefix(String prefix, String uri)
protected void	addToPool(OutputElement poolHead) Method called to temporarily link this instance to a pool, to allow reusing of instances with the same reader.
public OutputElement.PrefixState	Returns: OK, if passed-in prefix matches matched-in namespace URI in current scope; UNBOUND if it's not bound to anything, and MISBOUND if it's bound to another URI. checkPrefixValidity(String prefix, String nsURI, NamespaceContext rootNsContext) Method that verifies that passed-in non-empty prefix indeed maps to specified non-empty namespace URI; and depending on how it goes returns a status for caller.
protected OutputElement	createChild(WName name) Simplest factory method, which gets called when non-namespace element output method is called.
protected OutputElement	createChild(WName name, String uri) Full factory method, used for 'normal' namespace qualified output methods.
protected static OutputElement	createRoot()
public String	generatePrefix(NamespaceContext rootNsContext, String prefixBase, int[] seqArr)
public String	getDefaultNsURI()
public String	getExplicitPrefix(String uri, NamespaceContext rootNsContext) Method similar to `getPrefix`, but one that will not accept the default namespace, only an explicit one.
public String	getLocalName()
public WName	getName()
public String	Returns: String presentation of the fully-qualified name, in "prefix:localName" format (no URI). Useful for error and debugging messages. getNameDesc()
public String	getNamespaceURI()
public String	getNamespaceURI(String prefix)
public String	getNonNullNamespaceURI()
public String	getNonNullPrefix()
public OutputElement	getParent()
public String	getPrefix(String uri)
public Iterator<String>	getPrefixes(String uri, NamespaceContext rootNsContext)
public QName	getQName()
public boolean	hasEmptyDefaultNs()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	hasPrefix()
public boolean	isPrefixBoundTo(String prefix, String nsURI, NamespaceContext rootNsContext)
public boolean	isPrefixUnbound(String prefix, NamespaceContext rootNsContext)
public boolean	isRoot()
public void	relink(OutputElement parent) Method called to reuse a recycled instance, as is, with same name.
private void	relink(OutputElement parent, WName name, String uri) Method called to reuse a pooled instance, but with different name
protected OutputElement	Returns: New head of the recycle pool reuseAsChild(OutputElement parent, WName name)
protected OutputElement	reuseAsChild(OutputElement parent, WName name, String nsURI)
public void	setDefaultNsURI(String uri)

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

Field Detail

_defaultNsURI	back to summary
private String _defaultNsURI Namespace context end application may have supplied, and that (if given) should be used to augment explicitly defined bindings.

_name	back to summary
private WName _name Prefixed name used for serialization.

_nsBinder	back to summary
private NsBinder _nsBinder

_parent	back to summary
private OutputElement _parent Reference to either the parent (enclosing element) of this element, when part of active output context; or link to next reusable unused element after this one (if not part of active context).

_uri	back to summary
private String _uri Namespace of the element, whatever prefix part of `_name` maps to. Non-final to allow reuse.

BYTE_GT	back to summary
pack-priv static final byte BYTE_GT

BYTE_LT	back to summary
pack-priv static final byte BYTE_LT

BYTE_SLASH	back to summary
pack-priv static final byte BYTE_SLASH

Constructor Detail

OutputElement	back to summary
private OutputElement()

OutputElement	back to summary
private OutputElement(OutputElement parent, WName name, String uri, NsBinder binder)

Method Detail

addPrefix	back to summary
public void addPrefix(String prefix, String uri)

addToPool	back to summary
protected void addToPool(OutputElement poolHead) Method called to temporarily link this instance to a pool, to allow reusing of instances with the same reader.

checkPrefixValidity	back to summary
public OutputElement.PrefixState checkPrefixValidity(String prefix, String nsURI, NamespaceContext rootNsContext) Method that verifies that passed-in non-empty prefix indeed maps to specified non-empty namespace URI; and depending on how it goes returns a status for caller. Returns:OutputElement.PrefixState OK, if passed-in prefix matches matched-in namespace URI in current scope; UNBOUND if it's not bound to anything, and MISBOUND if it's bound to another URI.

checkPrefixValidity

back to summary

public OutputElement.PrefixState checkPrefixValidity(String prefix, String nsURI, NamespaceContext rootNsContext)

Method that verifies that passed-in non-empty prefix indeed maps to specified non-empty namespace URI; and depending on how it goes returns a status for caller.

Returns:OutputElement.PrefixState: OK, if passed-in prefix matches matched-in namespace URI in current scope; UNBOUND if it's not bound to anything, and MISBOUND if it's bound to another URI.

createChild	back to summary
protected OutputElement createChild(WName name) Simplest factory method, which gets called when non-namespace element output method is called. It is, then, assumed to use the default namespce.

createChild	back to summary
protected OutputElement createChild(WName name, String uri) Full factory method, used for 'normal' namespace qualified output methods.

createRoot	back to summary
protected static OutputElement createRoot()

generatePrefix	back to summary
public String generatePrefix(NamespaceContext rootNsContext, String prefixBase, int[] seqArr)

getDefaultNsURI	back to summary
public String getDefaultNsURI()

getExplicitPrefix	back to summary
public String getExplicitPrefix(String uri, NamespaceContext rootNsContext) Method similar to `getPrefix`, but one that will not accept the default namespace, only an explicit one. Usually used when trying to find a prefix for attributes.

getLocalName	back to summary
public String getLocalName()

getName	back to summary
public WName getName()

getNameDesc	back to summary
public String getNameDesc() Returns:String String presentation of the fully-qualified name, in "prefix:localName" format (no URI). Useful for error and debugging messages.

getNamespaceURI	back to summary
public String getNamespaceURI()

getNamespaceURI	back to summary
public String getNamespaceURI(String prefix)

getNonNullNamespaceURI	back to summary
public String getNonNullNamespaceURI()

getNonNullPrefix	back to summary
public String getNonNullPrefix()

getParent	back to summary
public OutputElement getParent()

getPrefix	back to summary
public String getPrefix(String uri)

getPrefixes	back to summary
public Iterator<String> getPrefixes(String uri, NamespaceContext rootNsContext) Annotations @SuppressWarnings:unchecked

getQName	back to summary
public QName getQName()

hasEmptyDefaultNs	back to summary
public boolean hasEmptyDefaultNs()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

hasPrefix	back to summary
public boolean hasPrefix()

isPrefixBoundTo	back to summary
public boolean isPrefixBoundTo(String prefix, String nsURI, NamespaceContext rootNsContext)

isPrefixUnbound	back to summary
public boolean isPrefixUnbound(String prefix, NamespaceContext rootNsContext)

isRoot	back to summary
public boolean isRoot()

relink	back to summary
public void relink(OutputElement parent) Method called to reuse a recycled instance, as is, with same name.

relink	back to summary
private void relink(OutputElement parent, WName name, String uri) Method called to reuse a pooled instance, but with different name

reuseAsChild	back to summary
protected OutputElement reuseAsChild(OutputElement parent, WName name) Returns:OutputElement New head of the recycle pool

reuseAsChild	back to summary
protected OutputElement reuseAsChild(OutputElement parent, WName name, String nsURI)

setDefaultNsURI	back to summary
public void setDefaultNsURI(String uri)

com.fasterxml.aalto.out back to summary

public final Enum OutputElement.PrefixState

Class Inheritance

extends Enum<OutputElement.PrefixState>

java.lang.Object
java.lang.Enum
com.fasterxml.aalto.out.OutputElement.PrefixState

Field Summary

Modifier and Type	Field and Description
public static final OutputElement.PrefixState	MISBOUND
public static final OutputElement.PrefixState	OK
public static final OutputElement.PrefixState	UNBOUND

Constructor Summary

Access	Constructor and Description
private	PrefixState()

Method Summary

Modifier and Type	Method and Description
public static OutputElement.PrefixState	valueOf(String name)
public static OutputElement.PrefixState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

MISBOUND	back to summary
public static final OutputElement.PrefixState MISBOUND

OK	back to summary
public static final OutputElement.PrefixState OK

UNBOUND	back to summary
public static final OutputElement.PrefixState UNBOUND

Constructor Detail

PrefixState	back to summary
private PrefixState()

Method Detail

valueOf	back to summary
public static OutputElement.PrefixState valueOf(String name)

values	back to summary
public static OutputElement.PrefixState[] values()

pack-priv final Class OutputElement

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum OutputElement.PrefixState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail