Project: stp

javax.wvcm
Class PropertyNameList.PropertyName<T>

Object
  extended by javax.wvcm.PropertyNameList.PropertyName<T>
All Implemented Interfaces:
PropertyRequestItem
Direct Known Subclasses:
CqQueryFolder.GroupAccessRightsName, CqQueryFolder.UserAccessRightsName, CqRecord.FieldName, CqUserDb.NamedValueName, StpProperty.MetaPropertyName
Enclosing class:
PropertyNameList

public static class PropertyNameList.PropertyName<T>
extends Object
implements PropertyRequestItem

The name of a property of a persistent resource. The PropertyName type parameter specifies the type of the value of the PropertyName


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.wvcm.PropertyRequestItem
PropertyRequestItem.NestedPropertyName<T>, PropertyRequestItem.PropertyRequest
 
Constructor Summary
PropertyNameList.PropertyName(String namespace, String name)
          Create a PropertyName with the given namespace and name.
 
Method Summary
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
 String getName()
          Get the property name.
 String getNamespace()
          Get the namespace of the property name.
 int hashCode()
          Calculate a hash code value for the object.
 PropertyRequestItem.NestedPropertyName<T> nest(PropertyNameList.PropertyName<?>[] pnl)
          A convenience method for constructing nested property names from a PropertyName[] without requiring an explicit cast to PropertyRequestItem[]
 PropertyRequestItem.NestedPropertyName<T> nest(PropertyRequestItem... pnl)
          Constructs a NestedPropertyName whose root property is this PropertyName with the property request items supplied as arguments as its nested property request.
 PropertyRequestItem.NestedPropertyName<T> nest(PropertyRequestItem.NestedPropertyName<?>[] pnl)
          A convenience method for constructing nested property names from a NestedPropertyName[] without requiring an explicit cast to PropertyRequestItem[]
 String toString()
          Returns a string representation of the PropertyName for diagnostic purposes.
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PropertyNameList.PropertyName

public PropertyNameList.PropertyName(String namespace,
                                     String name)
Create a PropertyName with the given namespace and name.

Parameters:
namespace - the namespace for this PropertyName. May be null to indicate a system property, or non-null to indicate a property in the specified name space.
name - the name for this property. May not be null.
Method Detail

equals

public boolean equals(Object o)
Indicates whether some other object is "equal to" this one.

Overrides:
equals in class Object
Parameters:
o - the object to compare with.
Returns:
true if and only if the specified object is a PropertyName whose type, namespace value, and name value equals those of this object.

getName

public String getName()
Get the property name.

Returns:
the name part of the property name

getNamespace

public String getNamespace()
Get the namespace of the property name.

Returns:
the namespace. May be null to indicate a system property, or non-null to indicate a property in the specified name space.

hashCode

public int hashCode()
Calculate a hash code value for the object.

Overrides:
hashCode in class Object
Returns:
the hash code for the object.

nest

public PropertyRequestItem.NestedPropertyName<T> nest(PropertyNameList.PropertyName<?>[] pnl)
A convenience method for constructing nested property names from a PropertyName[] without requiring an explicit cast to PropertyRequestItem[]

Parameters:
pnl - A PropertyName[] that specifies the nested properties of the NestedPropertyName to be constructed
Returns:
A NestedPropertyName whose root is this PropertyName and whose nested properties are the elements of the PropertyNames[] argument.

nest

public PropertyRequestItem.NestedPropertyName<T> nest(PropertyRequestItem... pnl)
Constructs a NestedPropertyName whose root property is this PropertyName with the property request items supplied as arguments as its nested property request. This method allows a more succinct syntax for the declaration of PropertyRequest objects at compile time. For example,
 final static PropertyRequest WORKSPACE_PROPERTIES = 
     new PropertyRequest(
         Workspace.DISPLAY_NAME,
         Workspace.COMMENT,
         Workspace.ACTIVITY_LIST.nest( 
             Activity.DISPLAY_NAME,
             Activity.ACTIVITY_VERSION_LIST.nest( 
                 Version.DISPLAY_NAME, 
                 Version.COMMENT, 
                 Version.CREATION_DATE)));
 

Parameters:
pnl - An array of PropertyRequestItem objects that specify the properties to be requested from the value of the property identified by this PropertyName.
Returns:
A NestedPropertyName whose root is this PropertyName and whose nested properties are the property request items given as arguments.

nest

public PropertyRequestItem.NestedPropertyName<T> nest(PropertyRequestItem.NestedPropertyName<?>[] pnl)
A convenience method for constructing nested property names from a NestedPropertyName[] without requiring an explicit cast to PropertyRequestItem[]

Parameters:
pnl - A NestedPropertyName[] that specifies the nested properties of the NestedPropertyName to be constructed
Returns:
A NestedPropertyName whose root is this PropertyName and whose nested properties are the elements of the NestedPropertyNames[] argument.

toString

public String toString()
Returns a string representation of the PropertyName for diagnostic purposes.

Overrides:
toString in class Object
Returns:
The string representation of this PropertyName in the format [namespace:]name.
See Also:
Object.toString()

Generated Fri 16-Aug-2013 12:43 PM

Copyright © IBM 2013. All rights reserved.