com.sapportals.wcm.repository

Class PropertyMap

java.lang.Object
  com.sapportals.wcm.WcmObject
      com.sapportals.wcm.repository.PropertyMap

All Implemented Interfaces:

IPropertyMap

Direct Known Subclasses:

MutablePropertyMap

public class PropertyMap
extends WcmObject
implements IPropertyMap

Holds a read-only map of Property objects.

Copyright SAP AG 2001-2004

Field Summary

protected Map	exceptionMap
protected HashMap	map

Fields inherited from class com.sapportals.wcm.WcmObject

ORDER_TYPE_MANUAL, ORDER_TYPE_NONE

Constructor Summary

	PropertyMap() Constructs a new empty property map.
protected	PropertyMap(int initialCapacity)
	PropertyMap(IPropertyMap propMap) Constructs a new property map with the same mappings as the given map.
protected	PropertyMap(Map m)
	PropertyMap(PropertyMap propMap) Constructs a new property map with the same mappings as the given map.

Method Summary

boolean	containsProperty(IProperty property) Returns true if the map contains the specified property.
boolean	containsProperty(IPropertyName propertyName) Returns true if the map contains a property with the specified name.
IProperty	get(IPropertyName propertyName) Returns the property with the specified name or null if there is no such property.
Exception	getException(IPropertyName propertyName) Given a property that does not appear in the property map, query for a possible exception that occured internally when computing it.
Map	getExceptions() Returns a map from IPropertyNames to Exceptions for every property for which an internal error occured during retrieval (not being defined is not an error condition).
IMutablePropertyMap	getMutable() Returns a copy of the map that can be modified.
boolean	isEmpty() Returns true if the map is empty.
IPropertyIterator	iterator() Returns an iterator for the property map.
int	size() Returns the number of properties in the map.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

map

protected HashMap map

exceptionMap

protected Map exceptionMap

Constructor Detail

PropertyMap

public PropertyMap()

Constructs a new empty property map.

PropertyMap

public PropertyMap(PropertyMap propMap)

Constructs a new property map with the same mappings as the given map.

Parameters:

propMap - The map whose mappings are to be copied.

PropertyMap

public PropertyMap(IPropertyMap propMap)

Constructs a new property map with the same mappings as the given map.

Parameters:

propMap - The map whose mappings are to be copied

PropertyMap

protected PropertyMap(int initialCapacity)

PropertyMap

protected PropertyMap(Map m)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

size

public int size()

Description copied from interface: IPropertyMap

Returns the number of properties in the map.

Specified by:

size in interface IPropertyMap

Returns:

the number of properties.

isEmpty

public boolean isEmpty()

Description copied from interface: IPropertyMap

Returns true if the map is empty.

Specified by:

isEmpty in interface IPropertyMap

Returns:

true if the map is empty.

containsProperty

public boolean containsProperty(IPropertyName propertyName)

Description copied from interface: IPropertyMap

Returns true if the map contains a property with the specified name.

Specified by:

containsProperty in interface IPropertyMap

Parameters:

propertyName - the property name to search for.

Returns:

true if the map contains a property with the specified name.

containsProperty

public boolean containsProperty(IProperty property)

Description copied from interface: IPropertyMap

Returns true if the map contains the specified property.

Specified by:

containsProperty in interface IPropertyMap

Parameters:

property - the property to search for.

Returns:

true if the map contains the specified property.

get

public IProperty get(IPropertyName propertyName)

Description copied from interface: IPropertyMap

Returns the property with the specified name or null if there is no such property.

Specified by:

get in interface IPropertyMap

Parameters:

propertyName - the property name to search for.

Returns:

the property with the specified name or null if there is no such property.

iterator

public IPropertyIterator iterator()

Description copied from interface: IPropertyMap

Returns an iterator for the property map.

Specified by:

iterator in interface IPropertyMap

Returns:

an iterator for the property map.

getMutable

public IMutablePropertyMap getMutable()

Description copied from interface: IPropertyMap

Returns a copy of the map that can be modified.

Specified by:

getMutable in interface IPropertyMap

Returns:

a copy of the map that can be modified.

getExceptions

public Map getExceptions()

Description copied from interface: IPropertyMap

Returns a map from IPropertyNames to Exceptions for every property for which an internal error occured during retrieval (not being defined is not an error condition).

Specified by:

getExceptions in interface IPropertyMap

Returns:

the map (will be empty if no exception have been recorded)

getException

public Exception getException(IPropertyName propertyName)

Description copied from interface: IPropertyMap

Given a property that does not appear in the property map, query for a possible exception that occured internally when computing it.

Specified by:

getException in interface IPropertyMap

Parameters:

propertyName - name of property

Returns:

the exception or null

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM