public interface IPcdNameFactory
IPcdName created by this factory class use string pooling
to share name components. Note that using these shared instances for short-term purposes (one request-response cycle)
may result in unnecessary memory consumption. For short-term purposes use CompositeName.
This interface is not intended to be implemented by clients.
| Modifier and Type | Method and Description |
|---|---|
IPcdName |
createPcdName()
Creates and returns an
IPcdName instance
using the PCD delimiter and standard PCD name validation. |
IPcdName |
createPcdName(int size)
Creates and returns an
IPcdName instance
of the provided (initial) size. |
IPcdName |
createPcdName(int size,
char delimiter,
boolean validateName)
Creates and returns an
IPcdName instance
using the given size and delimiter. |
IPcdName |
createPcdName(String name)
Creates and returns an
IPcdName representation
of the provided name using the PCD delimiter and standard PCD name validation. |
IPcdName |
createPcdName(String name,
char delimiter,
boolean validateName)
Creates and returns an
IPcdName representation
of the provided name, using the given delimiter. |
IPcdName |
createReadOnlyPcdName(String name)
Creates and returns a read-only
IPcdName representation
of the provided name using the PCD delimiter and standard PCD name validation. |
IPcdName |
createReadOnlyPcdName(String name,
char delimiter,
boolean validateName)
Creates and returns a read-only
IPcdName representation
of the provided name, using the given delimiter. |
IPcdName createPcdName()
IPcdName instance
using the PCD delimiter and standard PCD name validation.IPcdName instanceIPcdName createPcdName(int size)
IPcdName instance
of the provided (initial) size.
using the PCD delimiter and standard PCD name validation.size - (initial) size of the nameIPcdName instance of the provided (initial) size.IPcdName createPcdName(String name) throws InvalidNameException
IPcdName representation
of the provided name using the PCD delimiter and standard PCD name validation.name - String representation of the name to be parsed (not null)IPcdName representation
of the provided nameInvalidNameException - if the given name is invalidIPcdName createReadOnlyPcdName(String name) throws InvalidNameException
IPcdName representation
of the provided name using the PCD delimiter and standard PCD name validation. All modifying
operations on a read-only name throw a runtime exception.name - String representation of the name to be parsed (not null)IPcdName representation
of the provided nameInvalidNameException - if the given name is invalidIPcdName createPcdName(int size, char delimiter, boolean validateName)
IPcdName instance
using the given size and delimiter.
If name validation is required, standard PCD validation will be used.size - (initial) size of the namedelimiter - a character that will be used as the delimiter in the returned namevalidateName - defines if name components will be validated when added. If true, standard PCD name validation
will be used.IPcdName instance
using the given size and delimiterIPcdName createPcdName(String name, char delimiter, boolean validateName) throws InvalidNameException
IPcdName representation
of the provided name, using the given delimiter.
If name validation is required, standard PCD validation will be used.name - String representation of the name to be parsed (not null)delimiter - a character that will be used as the delimiter in the returned namevalidateName - defines if name components will be validated when added. If true, standard PCD name validation
will be used.IPcdName representation
of the provided name, using the given delimiter.InvalidNameException - if the given name is invalid and name validation is enabled (validateName is true).IPcdName createReadOnlyPcdName(String name, char delimiter, boolean validateName) throws InvalidNameException
IPcdName representation
of the provided name, using the given delimiter. If name validation is required,
standard PCD validation will be used. All modifying operations on a read-only
name throw a runtime exception.name - (initial) size of the namedelimiter - a character that will be used as the delimiter in the returned namevalidateName - defines if name components will be validated when added. If true, standard PCD name validation
will be used.IPcdName representation
of the provided name, using the given delimiterInvalidNameException - if the given name is invalid and name validation is enabled (validateName is true).| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] EP-BASIS
|
[sap.com]
|
api
|
BC-PIN-PCD
|
[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
|
[sap.com] EP-RUNTIME
|
[sap.com] tc/ep/semantics/api
|
api
|
EP-PIN
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2021 SAP SE Complete Copyright Notice