Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


oracle.wcps.property.model
Class PropertySet

java.lang.Object
  extended by oracle.wcps.property.model.Timestamped
      extended by oracle.wcps.property.model.PropertySet

All Implemented Interfaces:
java.io.Serializable, java.util.Map<java.lang.String,java.io.Serializable>, IPropertySet, ITimestamped

public class PropertySet
extends Timestamped
implements IPropertySet, java.io.Serializable

An implementation of IPropertySet. Use the builder builder() to create an instance of this.

See Also:
Serialized Form

Nested Class Summary
static class PropertySet.Builder
          The builder used for creating a PropertySet.

 

Method Summary
static PropertySet.Builder builder()
          Returns an instance of Builder to create a PropertySet.
 void clear()
           
 boolean containsKey(IPropertyName key)
          Returns true if this propertyset contains a mppaing for the specified property name key.
 boolean containsKey(java.lang.Object key)
           
 boolean containsValue(java.lang.Object value)
           
 java.util.Set<java.util.Map.Entry<java.lang.String,java.io.Serializable>> entrySet()
           
 boolean equals(java.lang.Object o)
           
 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.io.Serializable get(java.lang.Object key)
           
 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.
 java.lang.Object getRPropertySet()
           
 int hashCode()
           
 boolean isEmpty()
           
 void iterate(IPredicate<IProperty> predicate)
          Calls the given predicates IPredicate.apply(Object) method for each property found in this propertyset.
 java.util.Set<java.lang.String> keySet()
           
 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 IPropertySet.put(IPropertyName, java.io.Serializable) except it returns previously mapped value as a type of the given class c.
 java.io.Serializable put(java.lang.String key, java.io.Serializable value)
           
 void putAll(java.util.Map<? extends java.lang.String,? extends java.io.Serializable> m)
           
<T extends java.io.Serializable>
IProperty<T>
putProperty(IPropertyName key, IProperty<T> value)
          Associates the specified value with the given property name.
 java.io.Serializable remove(java.lang.Object key)
           
<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 setName)
          Sets the given propertySetName as the name of this.
 void setNamespaceName(INamespaceName namespaceName)
          Sets the given namespaceName as the associated namespace name.
 void setPropertySetDefinitionName(IPropertySetDefinitionName propertySetDefinitionName)
          Sets the given propertySetDefinitionName as the associated propertysetdefinition name.
 void setRPropertySet(RPropertySet rSet)
           
 int size()
           
 java.lang.String toString()
           
 java.util.Collection<java.io.Serializable> values()
           

 

Methods inherited from class oracle.wcps.property.model.Timestamped
getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Methods inherited from interface oracle.wcps.property.ITimestamped
getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn

 

Method Detail

name

public java.lang.String name()
Description copied from interface: IPropertySet
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]".
Specified by:
name in interface IPropertySet
Returns:
the string representation of the composite name.

getNamespaceName

public INamespaceName getNamespaceName()
Description copied from interface: IPropertySet
Returns the associated namespace name.
Specified by:
getNamespaceName in interface IPropertySet
Returns:
the associated namespace name.

setNamespaceName

public void setNamespaceName(INamespaceName namespaceName)
Description copied from interface: IPropertySet
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()
Specified by:
setNamespaceName in interface IPropertySet
Parameters:
namespaceName - the namespace name to which this will be associated.

getName

public IPropertySetName getName()
Description copied from interface: IPropertySet
Returns the propertyset name of this.
Specified by:
getName in interface IPropertySet
Returns:
the propertyset name of this.

setName

public void setName(IPropertySetName setName)
Description copied from interface: IPropertySet
Sets the given propertySetName as the name of this.
Specified by:
setName in interface IPropertySet
Parameters:
setName - a name for this.

getPropertySetDefinitionName

public IPropertySetDefinitionName getPropertySetDefinitionName()
Description copied from interface: IPropertySet
Returns the associated propertysetdefinition name.
Specified by:
getPropertySetDefinitionName in interface IPropertySet
Returns:
the associated propertysetdefinition name.

setPropertySetDefinitionName

public void setPropertySetDefinitionName(IPropertySetDefinitionName propertySetDefinitionName)
Description copied from interface: IPropertySet
Sets the given propertySetDefinitionName as the associated propertysetdefinition name.
Specified by:
setPropertySetDefinitionName in interface IPropertySet
Parameters:
propertySetDefinitionName - a propertysetdefinition name.

getDescription

public java.lang.String getDescription()
Description copied from interface: IPropertySet
Returns a brief description of this.
Specified by:
getDescription in interface IPropertySet
Returns:
a brief description.

setDescription

public void setDescription(java.lang.String desc)
Description copied from interface: IPropertySet
Sets the given desc as a brief description for this.
Specified by:
setDescription in interface IPropertySet
Parameters:
desc - a brief description.

getProperties

public java.util.List<IProperty<java.io.Serializable>> getProperties()
Description copied from interface: IPropertySet
Returns the list of properties of this propertyset.
Specified by:
getProperties in interface IPropertySet
Returns:
a list of properties.

get

public java.io.Serializable get(IPropertyName name)
Description copied from interface: IPropertySet
Returns the value associated with the given property name if mapped, or null if this propertyset contains no mapping for the given property name.
Specified by:
get in interface IPropertySet
Parameters:
name - a property name.
Returns:
the value for the given property name if found otherwise null.

put

public java.io.Serializable put(IPropertyName key,
                                java.io.Serializable value)
Description copied from interface: IPropertySet
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.
Specified by:
put in interface IPropertySet
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

public <T extends java.io.Serializable> T get(IPropertyName name,
                                              java.lang.Class<T> c)
Description copied from interface: IPropertySet
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.
Specified by:
get in interface IPropertySet
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

public <T extends java.io.Serializable> T put(IPropertyName key,
                                              T value,
                                              java.lang.Class<T> c)
Description copied from interface: IPropertySet
Same as IPropertySet.put(IPropertyName, java.io.Serializable) except it returns previously mapped value as a type of the given class c.
Specified by:
put in interface IPropertySet
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.

putProperty

public <T extends java.io.Serializable> IProperty<T> putProperty(IPropertyName key,
                                                                 IProperty<T> value)
Description copied from interface: IPropertySet
Associates the specified value with the given property name.
Specified by:
putProperty in interface IPropertySet
Type Parameters:
T - type for the value
Parameters:
key - a property name.
value - the property to be associated with the given property name.
Returns:
the property if mapped previously otherwise null.

getProperty

public <T extends java.io.Serializable> IProperty<T> getProperty(IPropertyName name)
Description copied from interface: IPropertySet
Returns the property with the given name if found otherwise null.
Specified by:
getProperty in interface IPropertySet
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.

removeProperty

public <T extends java.io.Serializable> IProperty<T> removeProperty(IPropertyName name)
Description copied from interface: IPropertySet
Removes the property associated with the given property name.
Specified by:
removeProperty in interface IPropertySet
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

public void iterate(IPredicate<IProperty> predicate)
Description copied from interface: IPropertySet
Calls the given predicates IPredicate.apply(Object) method for each property found in this propertyset.
Specified by:
iterate in interface IPropertySet
Parameters:
predicate - a predicate object.

containsKey

public boolean containsKey(IPropertyName key)
Description copied from interface: IPropertySet
Returns true if this propertyset contains a mppaing for the specified property name key.
Specified by:
containsKey in interface IPropertySet
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

size

public int size()
Specified by:
size in interface java.util.Map<java.lang.String,java.io.Serializable>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map<java.lang.String,java.io.Serializable>

containsKey

public boolean containsKey(java.lang.Object key)
Specified by:
containsKey in interface java.util.Map<java.lang.String,java.io.Serializable>

containsValue

public boolean containsValue(java.lang.Object value)
Specified by:
containsValue in interface java.util.Map<java.lang.String,java.io.Serializable>

get

public java.io.Serializable get(java.lang.Object key)
Specified by:
get in interface java.util.Map<java.lang.String,java.io.Serializable>

put

public java.io.Serializable put(java.lang.String key,
                                java.io.Serializable value)
Specified by:
put in interface java.util.Map<java.lang.String,java.io.Serializable>

remove

public java.io.Serializable remove(java.lang.Object key)
Specified by:
remove in interface java.util.Map<java.lang.String,java.io.Serializable>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.io.Serializable> m)
Specified by:
putAll in interface java.util.Map<java.lang.String,java.io.Serializable>

clear

public void clear()
Specified by:
clear in interface java.util.Map<java.lang.String,java.io.Serializable>

keySet

public java.util.Set<java.lang.String> keySet()
Specified by:
keySet in interface java.util.Map<java.lang.String,java.io.Serializable>

values

public java.util.Collection<java.io.Serializable> values()
Specified by:
values in interface java.util.Map<java.lang.String,java.io.Serializable>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.io.Serializable>> entrySet()
Specified by:
entrySet in interface java.util.Map<java.lang.String,java.io.Serializable>

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface java.util.Map<java.lang.String,java.io.Serializable>
Overrides:
equals in class Timestamped

hashCode

public int hashCode()
Specified by:
hashCode in interface java.util.Map<java.lang.String,java.io.Serializable>
Overrides:
hashCode in class Timestamped

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getRPropertySet

public java.lang.Object getRPropertySet()

setRPropertySet

public void setRPropertySet(RPropertySet rSet)

builder

public static PropertySet.Builder builder()
Returns an instance of Builder to create a PropertySet.
Returns:
an instance of Builder

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.