Skip navigation links

oracle.wcps.property
Interface IPropertySet

All Superinterfaces:

ITimestamped, java.util.Map<java.lang.String,java.io.Serializable>

All Known Implementing Classes:

PropertySet

public interface IPropertySet

extends ITimestamped, java.util.Map<java.lang.String,java.io.Serializable>

Represents a set of related properties scoped to a propertysetdefinition and a namespace. This is also a Map of string representation of property name and a serializable value.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

boolean	containsKey(IPropertyName key) Returns true if this propertyset contains a mppaing for the specified property name key.
java.io.Serializable	get(IPropertyName name) Returns the value associated with the given property name if mapped, or null if this propertyset contains no mapping for the given property name.
<T extends java.io.Serializable> T	get(IPropertyName name, java.lang.Class<T> c) Returns the value (casted to the given class c) associated with the given property name if mapped or null if this propertyset contains no mapping for the given property name.
java.lang.String	getDescription() Returns a brief description of this.
IPropertySetName	getName() Returns the propertyset name of this.
INamespaceName	getNamespaceName() Returns the associated namespace name.
java.util.List<IProperty<java.io.Serializable>>	getProperties() Returns the list of properties of this propertyset.
<T extends java.io.Serializable> IProperty<T>	getProperty(IPropertyName name) Returns the property with the given name if found otherwise null.
IPropertySetDefinitionName	getPropertySetDefinitionName() Returns the associated propertysetdefinition name.
void	iterate(IPredicate<IProperty> predicate) Calls the given predicates IPredicate.apply(Object) method for each property found in this propertyset.
java.lang.String	name() Returns the string representation of the composite name of this.
java.io.Serializable	put(IPropertyName key, java.io.Serializable value) Associates the specified value with the specified key in this propertySet.
<T extends java.io.Serializable> T	put(IPropertyName key, T value, java.lang.Class<T> c) Same as put(IPropertyName, java.io.Serializable) except it returns previously mapped value as a type of the given class c.
<T extends java.io.Serializable> IProperty<T>	putProperty(IPropertyName name, IProperty<T> value) Associates the specified value with the given property name.
<T extends java.io.Serializable> IProperty<T>	removeProperty(IPropertyName name) Removes the property associated with the given property name.
void	setDescription(java.lang.String desc) Sets the given desc as a brief description for this.
void	setName(IPropertySetName propertySetName) Sets the given propertySetName as the name of this.
void	setNamespaceName(INamespaceName namespaceName) Deprecated. it is a no op.
void	setPropertySetDefinitionName(IPropertySetDefinitionName propertySetDefinitionName) Sets the given propertySetDefinitionName as the associated propertysetdefinition name.

Methods inherited from interface oracle.wcps.property.ITimestamped

getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getNamespaceName

INamespaceName getNamespaceName()

Returns the associated namespace name.

Returns:

the associated namespace name.

setNamespaceName

void setNamespaceName(INamespaceName namespaceName)

Deprecated. it is a no op.

Sets the given namespaceName as the associated namespace name. Note: Calling this has no effect when using methods of IPropertyService, its overridden with the namespace name in IPropertyService.getNamespaceName()

Parameters:

namespaceName - the namespace name to which this will be associated.

getPropertySetDefinitionName

IPropertySetDefinitionName getPropertySetDefinitionName()

Returns the associated propertysetdefinition name.

Returns:

the associated propertysetdefinition name.

setPropertySetDefinitionName

void setPropertySetDefinitionName(IPropertySetDefinitionName propertySetDefinitionName)

Sets the given propertySetDefinitionName as the associated propertysetdefinition name.

Parameters:

propertySetDefinitionName - a propertysetdefinition name.

name

java.lang.String name()

Returns the string representation of the composite name of this. It is created by combining "[string representation of the namespace name of this]: [string representation of the propertysetdefinition name of this]:[string representation of the name of this]".

Returns:

the string representation of the composite name.

getName

IPropertySetName getName()

Returns the propertyset name of this.

Returns:

the propertyset name of this.

setName

void setName(IPropertySetName propertySetName)

Sets the given propertySetName as the name of this.

Parameters:

propertySetName - a name for this.

getDescription

java.lang.String getDescription()

Returns a brief description of this.

Returns:

a brief description.

setDescription

void setDescription(java.lang.String desc)

Sets the given desc as a brief description for this.

Parameters:

desc - a brief description.

get

java.io.Serializable get(IPropertyName name)

Returns the value associated with the given property name if mapped, or null if this propertyset contains no mapping for the given property name.

Parameters:

name - a property name.

Returns:

the value for the given property name if found otherwise null.

put

java.io.Serializable put(IPropertyName key,
                         java.io.Serializable value)

Associates the specified value with the specified key in this propertySet. If the propertySet previously contained a mapping for the given key, the old value is replaces by the specified value.

Parameters:

key - property name with which the specified value is to be associated.

value - value to be associated with specified key.

Returns:

the previous value associated with the key, or null if there was no mapping for key.

get

<T extends java.io.Serializable> T get(IPropertyName name,
                                       java.lang.Class<T> c)

Returns the value (casted to the given class c) associated with the given property name if mapped or null if this propertyset contains no mapping for the given property name.

Type Parameters:

T - type of a class.

Parameters:

name - a property name.

c - the class to which the value is casted to.

Returns:

the mapped value if found otherwise null.

put

<T extends java.io.Serializable> T put(IPropertyName key,
                                       T value,
                                       java.lang.Class<T> c)

Same as put(IPropertyName, java.io.Serializable) except it returns previously mapped value as a type of the given class c.

Type Parameters:

T - type of a class.

Parameters:

key - property name with which the specified value is to be associated.

value - value to be associated with specified key.

c - the class to which the previously mapped value is casted to.

Returns:

the previous value associated with the key, or null if there was no mapping for key.

containsKey

boolean containsKey(IPropertyName key)

Returns true if this propertyset contains a mppaing for the specified property name key.

Parameters:

key - proeprty name whose presence in this propertyset is to be tested.

Returns:

true if this propertyset contains a mapping for the specified property name key

getProperties

java.util.List<IProperty<java.io.Serializable>> getProperties()

Returns the list of properties of this propertyset.

Returns:

a list of properties.

getProperty

<T extends java.io.Serializable> IProperty<T> getProperty(IPropertyName name)

Returns the property with the given name if found otherwise null.

Type Parameters:

T - the property value's type.

Parameters:

name - a property's name

Returns:

the property with the given name if found in this propertyset, otherwise null.

putProperty

<T extends java.io.Serializable> IProperty<T> putProperty(IPropertyName name,
                                                          IProperty<T> value)

Associates the specified value with the given property name.

Type Parameters:

T - type for the value

Parameters:

name - a property name.

value - the property to be associated with the given property name.

Returns:

the property if mapped previously otherwise null.

removeProperty

<T extends java.io.Serializable> IProperty<T> removeProperty(IPropertyName name)

Removes the property associated with the given property name.

Type Parameters:

T - the property value's type.

Parameters:

name - a property name

Returns:

the removed property if the given name previously mapped otherwise null

iterate

void iterate(IPredicate<IProperty> predicate)

Calls the given predicates IPredicate.apply(Object) method for each property found in this propertyset.

Parameters:

predicate - a predicate object.

Skip navigation links