Modifier and Type	Class and Description
public class	NamespaceContextImpl.Element This model of namespace declarations maintain the following invariants.

Modifier and Type	Field and Description
public boolean	collectionMode True to allow new URIs to be declared.
private NamespaceContextImpl.Element	current
private static final NamespacePrefixMapper	defaultNamespacePrefixMapper Default `NamespacePrefixMapper` implementation used when it is not specified by the user.
private String[]	nsUris
private final XMLSerializer	owner
private String[]	prefixes
private NamespacePrefixMapper	prefixMapper Never null.
private int	size Number of URIs declared.
private final NamespaceContextImpl.Element	top This is the `Element` whose prev==null.

Access	Constructor and Description
public	NamespaceContextImpl(XMLSerializer owner)

Method Summary

Modifier and Type	Method and Description
public int	count() Number of total bindings declared.
public String	declareNamespace(String namespaceUri, String preferedPrefix, boolean requirePrefix) Implements org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.declareNamespace. Declares a new namespace binding within the current context.
public int	declareNsUri(String uri, String preferedPrefix, boolean requirePrefix) Returns the prefix index to the specified URI.
public int	force(String uri, String prefix) Implements org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.force. Forcibly make a namespace declaration in effect.
public NamespaceContextImpl.Element	getCurrent()
public String	getNamespaceURI(int prefixIndex)
public String	Returns: null if the prefix is unbound. getNamespaceURI(String prefix) Implements javax.xml.namespace.NamespaceContext.getNamespaceURI. Gets the namespace URI that is bound to the specified prefix.
public String	getPrefix(int prefixIndex) Gets the prefix from a prefix index.
public String	getPrefix(String uri) Implements javax.xml.namespace.NamespaceContext.getPrefix. Returns the prefix of the specified URI, or null if none exists.
public Iterator<String>	getPrefixes(String uri) Implements javax.xml.namespace.NamespaceContext.getPrefixes. Get all prefixes bound to a Namespace URI in the current scope.
public int	getPrefixIndex(String uri) Returns the prefix index of the specified URI.
public NamespacePrefixMapper	getPrefixMapper()
private String	makeUniquePrefix()
public int	Returns: the index of this new binding. put(String uri, String prefix) Puts this new binding into the declared prefixes list without doing any duplicate check.
public void	reset()
public void	setPrefixMapper(NamespacePrefixMapper mapper)

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

Field Detail

collectionMode	back to summary
public boolean collectionMode True to allow new URIs to be declared. False otherwise.

current	back to summary
private NamespaceContextImpl.Element current

defaultNamespacePrefixMapper	back to summary
private static final NamespacePrefixMapper defaultNamespacePrefixMapper Default `NamespacePrefixMapper` implementation used when it is not specified by the user.

nsUris	back to summary
private String[] nsUris

owner	back to summary
private final XMLSerializer owner

prefixes	back to summary
private String[] prefixes

prefixMapper	back to summary
private NamespacePrefixMapper prefixMapper Never null.

size	back to summary
private int size Number of URIs declared. Identifies the valid portion of the `prefixes` and `nsUris` arrays.

top back to summary

top	back to summary
private final NamespaceContextImpl.Element top This is the `Element` whose prev==null. This element is used to hold the contextual namespace bindings that are assumed to be outside of the document we are marshalling. Specifically the xml prefix and any other user-specified bindings. See Also `NamespacePrefixMapper#getPreDeclaredNamespaceUris()`

private final NamespaceContextImpl.Element top

This is the Element whose prev==null. This element is used to hold the contextual namespace bindings that are assumed to be outside of the document we are marshalling. Specifically the xml prefix and any other user-specified bindings.

See Also: NamespacePrefixMapper#getPreDeclaredNamespaceUris()

Constructor Detail

NamespaceContextImpl	back to summary
public NamespaceContextImpl(XMLSerializer owner)

Method Detail

count	back to summary
public int count() Number of total bindings declared.

declareNamespace	back to summary
public String declareNamespace(String namespaceUri, String preferedPrefix, boolean requirePrefix) Implements org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.declareNamespace. Doc from org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.declareNamespace. Declares a new namespace binding within the current context. The prefix is automatically assigned by MarshallingContext. If a given namespace URI is already declared, nothing happens. It is NOT an error to declare the same namespace URI more than once. For marshalling to work correctly, all namespace bindings for an element must be declared between its startElement method and its endAttributes event. Calling the same method with the same parameter between the endAttributes and the endElement returns the same prefix. Annotations @Override

declareNamespace

back to summary

public String declareNamespace(String namespaceUri, String preferedPrefix, boolean requirePrefix)

Implements org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.declareNamespace.

Doc from org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.declareNamespace.

Declares a new namespace binding within the current context.

The prefix is automatically assigned by MarshallingContext. If a given namespace URI is already declared, nothing happens.

It is NOT an error to declare the same namespace URI more than once.

For marshalling to work correctly, all namespace bindings for an element must be declared between its startElement method and its endAttributes event. Calling the same method with the same parameter between the endAttributes and the endElement returns the same prefix.

Annotations

@Override

declareNsUri	back to summary
public int declareNsUri(String uri, String preferedPrefix, boolean requirePrefix) Returns the prefix index to the specified URI. This method allocates a new URI if necessary.

force	back to summary
public int force(String uri, String prefix) Implements org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.force. Doc from org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.force. Forcibly make a namespace declaration in effect. If the (prefix,uri) binding is already in-scope, this method simply returns the assigned prefix index. Otherwise a new declaration will be put. Annotations @Override

force

back to summary

public int force(String uri, String prefix)

Implements org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.force.

Doc from org.glassfish.jaxb.runtime.v2.runtime.NamespaceContext2.force.

Forcibly make a namespace declaration in effect. If the (prefix,uri) binding is already in-scope, this method simply returns the assigned prefix index. Otherwise a new declaration will be put.

Annotations

@Override

getCurrent	back to summary
public NamespaceContextImpl.Element getCurrent()

getNamespaceURI	back to summary
public String getNamespaceURI(int prefixIndex)

getNamespaceURI	back to summary
public String getNamespaceURI(String prefix) Implements javax.xml.namespace.NamespaceContext.getNamespaceURI. Gets the namespace URI that is bound to the specified prefix. Returns:String null if the prefix is unbound. Annotations @Override

getNamespaceURI

back to summary

public String getNamespaceURI(String prefix)

Implements javax.xml.namespace.NamespaceContext.getNamespaceURI.

Gets the namespace URI that is bound to the specified prefix.

Returns:String

null if the prefix is unbound.

Annotations

@Override

getPrefix	back to summary
public String getPrefix(int prefixIndex) Gets the prefix from a prefix index. The behavior is undefined if the index is out of range.

getPrefix	back to summary
public String getPrefix(String uri) Implements javax.xml.namespace.NamespaceContext.getPrefix. Returns the prefix of the specified URI, or null if none exists. Annotations @Override

getPrefix

back to summary

public String getPrefix(String uri)

Implements javax.xml.namespace.NamespaceContext.getPrefix.

Returns the prefix of the specified URI, or null if none exists.

Annotations

@Override

getPrefixes back to summary

public Iterator<String> getPrefixes(String uri)

Implements javax.xml.namespace.NamespaceContext.getPrefixes.

Doc from javax.xml.namespace.NamespaceContext.getPrefixes.

Get all prefixes bound to a Namespace URI in the current scope.

An Iterator over String elements is returned in an arbitrary, implementation dependent, order.

The Iterator is not modifiable. e.g. the remove() method will throw UnsupportedOperationException.

When requesting prefixes by Namespace URI, the following table describes the returned prefixes value for all Namespace URI values:

Return value for specified Namespace URIs
Namespace URI parameter	prefixes value returned
bound Namespace URI, including the `<default Namespace URI>`	`Iterator` over prefixes bound to Namespace URI in the current scope in an arbitrary, implementation dependent, order
unbound Namespace URI	empty `Iterator`
`XMLConstants.XML_NS_URI` ("http://www.w3.org/XML/1998/namespace")	`Iterator` with one element set to `XMLConstants.XML_NS_PREFIX` ("xml")
`XMLConstants.XMLNS_ATTRIBUTE_NS_URI` ("http://www.w3.org/2000/xmlns/")	`Iterator` with one element set to `XMLConstants.XMLNS_ATTRIBUTE` ("xmlns")
`null`	`IllegalArgumentException` is thrown

Annotations

@Override

getPrefixIndex	back to summary
public int getPrefixIndex(String uri) Returns the prefix index of the specified URI. It is an error if the URI is not declared.

getPrefixMapper	back to summary
public NamespacePrefixMapper getPrefixMapper()

makeUniquePrefix	back to summary
private String makeUniquePrefix()

put back to summary

put	back to summary
public int put(String uri, String prefix) Puts this new binding into the declared prefixes list without doing any duplicate check. This can be used to forcibly set namespace declarations. Most of the time `declareNamespace(String, String, boolean)` shall be used. Returns:int the index of this new binding.

public int put(String uri, String prefix)

Puts this new binding into the declared prefixes list without doing any duplicate check. This can be used to forcibly set namespace declarations.

Most of the time declareNamespace(String, String, boolean) shall be used.

Returns:int: the index of this new binding.

reset	back to summary
public void reset()

setPrefixMapper	back to summary
public void setPrefixMapper(NamespacePrefixMapper mapper)

org.glassfish.jaxb.runtime.v2.runtime.output back to summary

public final Class NamespaceContextImpl.Element

Class Inheritance

extends Object

java.lang.Object
org.glassfish.jaxb.runtime.v2.runtime.output.NamespaceContextImpl.Element

This model of namespace declarations maintain the following invariants.

If a non-empty prefix is declared, it will never be reassigned to different namespace URIs.

Field Summary

Modifier and Type	Field and Description
private int	baseIndex The numbe of prefixes declared by ancestor `Element`s.
public final NamespaceContextImpl	context
private int	defaultPrefixIndex
private final int	depth The depth of the `Element`.
private String	elementLocalName
private Name	elementName Tag name of this element.
private int	elementNamePrefix
private Object	innerPeer
private NamespaceContextImpl.Element	next
private int	oldDefaultNamespaceUriIndex
private Object	outerPeer Used for the binder.
private final NamespaceContextImpl.Element	prev `Element`s form a doubly-linked list.

Constructor Summary

Access	Constructor and Description
private	Element(NamespaceContextImpl context, NamespaceContextImpl.Element prev)

Method Summary

Modifier and Type	Method and Description
public int	count() Gets the number of bindings declared on this element.
public void	endElement(XmlOutput out)
public int	getBase()
public Object	getInnerPeer()
public String	getNsUri(int between 0 and `count()` idx) Gets the namespace URI declared in this context.
public Object	getOuterPeer()
public NamespaceContextImpl.Element	getParent() Gets the parent .
public String	getPrefix(int between 0 and `count()` idx) Gets the prefix declared in this context.
public boolean	isRootElement() Returns true if this represents the root element that we are marshalling.
private void	onPushed()
public NamespaceContextImpl.Element	pop()
public NamespaceContextImpl.Element	push()
public void	setTagName(int prefix, String localName, Object outerPeer)
public void	setTagName(Name tagName, Object outerPeer)
public void	startElement(XmlOutput out, Object innerPeer)

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

Field Detail

baseIndex	back to summary
private int baseIndex The numbe of prefixes declared by ancestor `Element`s.

context	back to summary
public final NamespaceContextImpl context

defaultPrefixIndex	back to summary
private int defaultPrefixIndex

depth back to summary

depth	back to summary
private final int depth The depth of the `Element`. This value is equivalent as the result of the following computation. int depth() { int i=-1; for(Element e=this; e!=null;e=e.prev) i++; return i; }

private final int depth

The depth of the Element. This value is equivalent as the result of the following computation.

int depth() {
  int i=-1;
  for(Element e=this; e!=null;e=e.prev)
    i++;
  return i;
}

elementLocalName	back to summary
private String elementLocalName

elementName	back to summary
private Name elementName Tag name of this element. Either this field is used or the `elementNamePrefix` and `elementLocalName` pair.

elementNamePrefix	back to summary
private int elementNamePrefix

innerPeer	back to summary
private Object innerPeer

next	back to summary
private NamespaceContextImpl.Element next

oldDefaultNamespaceUriIndex	back to summary
private int oldDefaultNamespaceUriIndex

outerPeer	back to summary
private Object outerPeer Used for the binder. The JAXB object that corresponds to this element.

prev	back to summary
private final NamespaceContextImpl.Element prev `Element`s form a doubly-linked list.

Constructor Detail

Element	back to summary
private Element(NamespaceContextImpl context, NamespaceContextImpl.Element prev)

Method Detail

count	back to summary
public int count() Gets the number of bindings declared on this element.

endElement	back to summary
public void endElement(XmlOutput out) throws IOException, SAXException, XMLStreamException

getBase	back to summary
public int getBase()

getInnerPeer	back to summary
public Object getInnerPeer()

getNsUri back to summary

public String getNsUri(int idx)

Gets the namespace URI declared in this context.

Parameters

idx:int: between 0 and count()

getOuterPeer	back to summary
public Object getOuterPeer()

getParent	back to summary
public NamespaceContextImpl.Element getParent() Gets the parent .

getPrefix back to summary

public String getPrefix(int idx)

Gets the prefix declared in this context.

Parameters

idx:int: between 0 and count()

isRootElement	back to summary
public boolean isRootElement() Returns true if this represents the root element that we are marshalling.

onPushed	back to summary
private void onPushed()

pop	back to summary
public NamespaceContextImpl.Element pop()

push	back to summary
public NamespaceContextImpl.Element push()

setTagName	back to summary
public void setTagName(int prefix, String localName, Object outerPeer)

setTagName	back to summary
public void setTagName(Name tagName, Object outerPeer)

startElement	back to summary
public void startElement(XmlOutput out, Object innerPeer) throws IOException, XMLStreamException

public final Class NamespaceContextImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class NamespaceContextImpl.Element

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail