Top Description Inners Fields Constructors Methods
org.apache.xerces.util

public Class AugmentationsImpl

extends Object
implements Augmentations
Class Inheritance
All Implemented Interfaces
org.apache.xerces.xni.Augmentations
Imports
java.util.Collections, .Enumeration, .HashMap, .Iterator, .Map, org.apache.xerces.xni.Augmentations

This class provides an implementation for Augmentations interface. Augmentations interface defines a hashtable of additional data that could be passed along the document pipeline. The information can contain extra arguments or infoset augmentations, for example PSVI. This additional information is identified by a String key.

Author
Elena Litani, IBM
Version
$Id: AugmentationsImpl.java 606488 2007-12-22 20:40:16Z mrglavas $

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv abstract static class
pack-priv static class
pack-priv static class

Field Summary

Modifier and TypeField and Description
private AugmentationsImpl.AugmentationsItemsContainer

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

the value to which the key is mapped in the Augmentations structure; null if the key is not mapped to any value.
getItem
(String
Identifier, can't be null
key
)

Implements org.apache.xerces.xni.Augmentations.getItem.

Get information identified by a key from the Augmentations structure
public Enumeration<E>
keys()

Implements org.apache.xerces.xni.Augmentations.keys.

Returns an enumeration of the keys in the Augmentations structure
public Object

Returns:

the previous value of the specified key in the Augmentations strucutre, or null if it did not have one.
putItem
(String
Identifier, can't be null
key
,
Object
Additional information
item
)

Implements org.apache.xerces.xni.Augmentations.putItem.

Add additional information identified by a key to the Augmentations structure.
public void
removeAllItems()

Implements org.apache.xerces.xni.Augmentations.removeAllItems.

Remove all objects from the Augmentations structure.
public Object
removeItem(String
Identifier, can't be null
key
)

Implements org.apache.xerces.xni.Augmentations.removeItem.

Remove additional info from the Augmentations structure
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

fAugmentationsContainerback to summary
private AugmentationsImpl.AugmentationsItemsContainer fAugmentationsContainer

Constructor Detail

AugmentationsImplback to summary
public AugmentationsImpl()

Method Detail

getItemback to summary
public Object getItem(String key)

Implements org.apache.xerces.xni.Augmentations.getItem.

Get information identified by a key from the Augmentations structure

Parameters
key:String

Identifier, can't be null

Returns:Object

the value to which the key is mapped in the Augmentations structure; null if the key is not mapped to any value.

keysback to summary
public Enumeration<E> keys()

Implements org.apache.xerces.xni.Augmentations.keys.

Returns an enumeration of the keys in the Augmentations structure

putItemback to summary
public Object putItem(String key, Object item)

Implements org.apache.xerces.xni.Augmentations.putItem.

Add additional information identified by a key to the Augmentations structure.

Parameters
key:String

Identifier, can't be null

item:Object

Additional information

Returns:Object

the previous value of the specified key in the Augmentations strucutre, or null if it did not have one.

removeAllItemsback to summary
public void removeAllItems()

Implements org.apache.xerces.xni.Augmentations.removeAllItems.

Remove all objects from the Augmentations structure.

removeItemback to summary
public Object removeItem(String key)

Implements org.apache.xerces.xni.Augmentations.removeItem.

Remove additional info from the Augmentations structure

Parameters
key:String

Identifier, can't be null

Returns:Object

Doc from org.apache.xerces.xni.Augmentations.removeItem.

the previous value of the specified key in the Augmentations structure, or null if it did not have one.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

org.apache.xerces.util back to summary

pack-priv abstract Class AugmentationsImpl.AugmentationsItemsContainer

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer
Known Direct Subclasses
org.apache.xerces.util.AugmentationsImpl.SmallContainer, org.apache.xerces.util.AugmentationsImpl.LargeContainer

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public abstract void
public abstract AugmentationsImpl.AugmentationsItemsContainer
public abstract Object
public abstract boolean
public abstract Enumeration<E>
keys()

public abstract Object
putItem(Object key, Object item)

public abstract Object
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AugmentationsItemsContainerback to summary
pack-priv AugmentationsItemsContainer()

Method Detail

clearback to summary
public abstract void clear()
expandback to summary
public abstract AugmentationsImpl.AugmentationsItemsContainer expand()
getItemback to summary
public abstract Object getItem(Object key)
isFullback to summary
public abstract boolean isFull()
keysback to summary
public abstract Enumeration<E> keys()
putItemback to summary
public abstract Object putItem(Object key, Object item)
removeItemback to summary
public abstract Object removeItem(Object key)
org.apache.xerces.util back to summary

pack-priv final Class AugmentationsImpl.LargeContainer

extends AugmentationsItemsContainer
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final HashMap<K, V>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
public AugmentationsImpl.AugmentationsItemsContainer
public Object
public boolean
public Enumeration<E>
public Object
public Object
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Field Detail

fAugmentationsback to summary
private final HashMap<K, V> fAugmentations

Constructor Detail

LargeContainerback to summary
pack-priv LargeContainer()

Method Detail

clearback to summary
public void clear()

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.clear.

expandback to summary
public AugmentationsImpl.AugmentationsItemsContainer expand()

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.expand.

getItemback to summary
public Object getItem(Object key)

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.getItem.

isFullback to summary
public boolean isFull()

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.isFull.

keysback to summary
public Enumeration<E> keys()

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.keys.

putItemback to summary
public Object putItem(Object key, Object item)

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.putItem.

removeItemback to summary
public Object removeItem(Object key)

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.removeItem.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

org.apache.xerces.util back to summary

pack-priv final Class AugmentationsImpl.SmallContainer

extends AugmentationsItemsContainer
Class Inheritance

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class

Field Summary

Modifier and TypeField and Description
pack-priv final Object[]
pack-priv int
pack-priv static final int

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
public AugmentationsImpl.AugmentationsItemsContainer
public Object
public boolean
public Enumeration<E>
public Object
public Object
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Field Detail

fAugmentationsback to summary
pack-priv final Object[] fAugmentations
fNumEntriesback to summary
pack-priv int fNumEntries
SIZE_LIMITback to summary
pack-priv static final int SIZE_LIMIT

Constructor Detail

SmallContainerback to summary
pack-priv SmallContainer()

Method Detail

clearback to summary
public void clear()

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.clear.

expandback to summary
public AugmentationsImpl.AugmentationsItemsContainer expand()

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.expand.

getItemback to summary
public Object getItem(Object key)

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.getItem.

isFullback to summary
public boolean isFull()

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.isFull.

keysback to summary
public Enumeration<E> keys()

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.keys.

putItemback to summary
public Object putItem(Object key, Object item)

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.putItem.

removeItemback to summary
public Object removeItem(Object key)

Implements abstract org.apache.xerces.util.AugmentationsImpl.AugmentationsItemsContainer.removeItem.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

org.apache.xerces.util back to summary

pack-priv final Class AugmentationsImpl.SmallContainer.SmallContainerKeyEnumeration

extends Object
implements Enumeration
Class Inheritance
  • java.lang.Object
  • org.apache.xerces.util.AugmentationsImpl.SmallContainer.SmallContainerKeyEnumeration
All Implemented Interfaces
java.util.Enumeration

Field Summary

Modifier and TypeField and Description
pack-priv Object[]
pack-priv int

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
hasMoreElements()

Implements java.util.Enumeration.hasMoreElements.

Tests if this enumeration contains more elements.
public Object
nextElement()

Implements java.util.Enumeration.nextElement.

Returns the next element of this enumeration if this enumeration object has at least one more element to provide.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

enumArrayback to summary
pack-priv Object[] enumArray
nextback to summary
pack-priv int next

Constructor Detail

SmallContainerKeyEnumerationback to summary
pack-priv SmallContainerKeyEnumeration()

Method Detail

hasMoreElementsback to summary
public boolean hasMoreElements()

Implements java.util.Enumeration.hasMoreElements.

Doc from java.util.Enumeration.hasMoreElements.

Tests if this enumeration contains more elements.

Returns:boolean

true if and only if this enumeration object contains at least one more element to provide; false otherwise.

nextElementback to summary
public Object nextElement()

Implements java.util.Enumeration.nextElement.

Doc from java.util.Enumeration.nextElement.

Returns the next element of this enumeration if this enumeration object has at least one more element to provide.

Returns:Object

the next element of this enumeration.