com.sapportals.portal.pcd.gl

Interface IPcdName

All Superinterfaces:

Cloneable, Comparable<Object>, Name, Serializable

public interface IPcdName
extends Name

This interface represents a PCD name. PCD names can be created using the default delimiter ('/'), or any custom delimiter (can be provided on name creation). It also supports name validation - Allowed characters are "0" to "9", "A" to "Z", "a" to "z", and the special characters defined in ALLOWED_NO_ESC. The length of atomic names (name components) is restricted. Get the maximum length using the method IPcdObjectFactory.getMaxLengthAtomicName. This value is currently 105. Name validation is optional, and is enabled by default. To create a name with no validation use the appropriate methods in IPcdNameFactory. PCD names can be set to read-only, which allows to use them e.g. as cache-keys. All modifying operations on a read-only name throw a runtime exception.

This interface is not intended to be implemented by clients.

Field Summary

static String	ALLOWED_NO_ESC The allowed special characters in the PcdName.
static char	SYNTAX_SEPARATOR The standard PCD syntax delimiter which separates the name components in the string representation of the name.

Fields inherited from interface javax.naming.Name

serialVersionUID

Method Summary

Object	clone() Generates a new mutable copy of this name.
boolean	equals(Object obj) Determines whether two composite names are equal.
boolean	isReadOnly()
IPcdName	setReadOnly() Sets the name to read-only mode.

Methods inherited from interface javax.naming.Name

add, add, addAll, addAll, compareTo, endsWith, get, getAll, getPrefix, getSuffix, isEmpty, remove, size, startsWith

Field Detail

SYNTAX_SEPARATOR

static final char SYNTAX_SEPARATOR

The standard PCD syntax delimiter which separates the name components in the string representation of the name.

See Also:

Constant Field Values

ALLOWED_NO_ESC

static final String ALLOWED_NO_ESC

The allowed special characters in the PcdName.

See Also:

Constant Field Values

Method Detail

setReadOnly

IPcdName setReadOnly()

Sets the name to read-only mode. All modifying operations on a read-only name throw a runtime exception.

Returns:

the immutable name (this)

isReadOnly

boolean isReadOnly()

Returns:

true if this name is read-only, otherwise false.

clone

Object clone()

Generates a new mutable copy of this name. Subsequent changes to the components of this name will not affect the new copy, and vice versa.

Specified by:

clone in interface Name

Returns:

a mutable copy of this name

See Also:

Object.clone()

equals

boolean equals(Object obj)

Determines whether two composite names are equal. If obj is null or not a composite name, false is returned. Two composite names are equal if each component in one is equal to the corresponding component in the other. This implies both have the same number of components, and each component's equals() test against the corresponding component in the other name returns true. Two names are considered equal when all name components are equal even if a different delimiter is used in each name.

Overrides:

equals in class Object

Parameters:

obj - The possibly null object to compare against.

Returns:

true if obj is equal to this composite name, false otherwise.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS	[sap.com] tc/epbc/pcd/pars/srvgldeprecated	api	BC-PIN-PCD
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcd/gl/api	-	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcd/gl/api	api	EP-PIN