Woodstox 6.5.1 · com.ctc.wstx.util.BijectiveNsMap · APIdia, the JavaDoc alternative

Helper class that implements "bijective map" (Map that allows use of values as keys and vice versa, bidirectional access), and is specifically used for storing namespace binding information. One thing worth noting is that Strings stored are NOT assumed to have been unified (interned) -- if they were, different implementation would be more optimal.

Currently only used by stream writers, but could be more generally useful too.

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	DEFAULT_ARRAY_SIZE Let's plan for having up to 14 explicit namespace declarations (2 defaults, for 'xml' and 'xmlns', are pre-populated)
private static final int	MAX_LOOP_FOR_NEW_PREFIX As a simple protection against infinite loops, use an arbitrary but bound limit for iterators
pack-priv String[]	mNsStrings Array that contains { prefix, ns-uri } pairs, up to (but not including) index `mScopeEnd`.
pack-priv int	mScopeEnd
pack-priv final int	mScopeStart

Access	Constructor and Description
private	BijectiveNsMap(int scopeStart, String[] strs)

Method Summary

Modifier and Type	Method and Description
public String	addGeneratedMapping(String prefixBase, NamespaceContext ctxt, String uri, int[] seqArr) Method used to add a dynamic binding, and return the prefix used to bind the specified namespace URI.
public String	Returns: If the prefix was already bound, the URI it was bound to: null if it's a new binding for the current scope. addMapping(String Prefix to bind prefix, String URI to bind to the prefix uri) Method to add a new prefix-to-URI mapping for the current scope.
public BijectiveNsMap	createChild()
public static BijectiveNsMap	createEmpty()
public String	findPrefixByUri(String uri)
public String	findUriByPrefix(String prefix)
public List<String>	getPrefixesBoundToUri(String uri, List<String> l)
public int	localSize()
public int	size()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

DEFAULT_ARRAY_SIZE	back to summary
pack-priv static final int DEFAULT_ARRAY_SIZE Let's plan for having up to 14 explicit namespace declarations (2 defaults, for 'xml' and 'xmlns', are pre-populated)

MAX_LOOP_FOR_NEW_PREFIX	back to summary
private static final int MAX_LOOP_FOR_NEW_PREFIX As a simple protection against infinite loops, use an arbitrary but bound limit for iterators

mNsStrings	back to summary
pack-priv String[] mNsStrings Array that contains { prefix, ns-uri } pairs, up to (but not including) index `mScopeEnd`.

mScopeEnd	back to summary
pack-priv int mScopeEnd

mScopeStart	back to summary
pack-priv final int mScopeStart

Constructor Detail

BijectiveNsMap	back to summary
private BijectiveNsMap(int scopeStart, String[] strs)

Method Detail

addGeneratedMapping	back to summary
public String addGeneratedMapping(String prefixBase, NamespaceContext ctxt, String uri, int[] seqArr) Method used to add a dynamic binding, and return the prefix used to bind the specified namespace URI.

addMapping	back to summary
public String addMapping(String prefix, String uri) Method to add a new prefix-to-URI mapping for the current scope. Note that it should NOT be used for the default namespace declaration Parameters prefix:String Prefix to bind uri:String URI to bind to the prefix Returns:String If the prefix was already bound, the URI it was bound to: null if it's a new binding for the current scope.

addMapping

back to summary

public String addMapping(String prefix, String uri)

Method to add a new prefix-to-URI mapping for the current scope. Note that it should NOT be used for the default namespace declaration

Parameters

prefix:String: Prefix to bind
uri:String: URI to bind to the prefix

Returns:String

If the prefix was already bound, the URI it was bound to: null if it's a new binding for the current scope.

createChild	back to summary
public BijectiveNsMap createChild()

createEmpty	back to summary
public static BijectiveNsMap createEmpty()

findPrefixByUri	back to summary
public String findPrefixByUri(String uri)

findUriByPrefix	back to summary
public String findUriByPrefix(String prefix)

getPrefixesBoundToUri	back to summary
public List<String> getPrefixesBoundToUri(String uri, List<String> l)

localSize	back to summary
public int localSize()

size	back to summary
public int size()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public final Class BijectiveNsMap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail