javax.wvcm
Class PropertyNameList

java.lang.Object
  extended by javax.wvcm.PropertyNameList

public final class PropertyNameList
extends java.lang.Object

A list of resource property names. One of the most common applications of a PropertyNameList is to identify a list of property values to be retrieved from a persistent resource.

The property names can be nested, reflecting the fact that property values can be objects that in turn have properties. For example, the following code fragment creates a property name list that identifies the CREATOR_DISPLAYNAME, CHECKED_IN, and LAST_MODIFIED properties, as well as the VERSION_NAME and CREATION_DATE of the value of the CHECKED_IN property:

 PropertyNameList pnl =
 new PropertyNameList(new PropertyName[] {
 PropertyName.CREATOR_DISPLAY_NAME,
 new NestedPropertyName(
 PropertyName.CHECKED_IN,
 new PropertyNameList(new PropertyName[] {
 PropertyName.VERSION_NAME,
 PropertyName.CREATION_DATE }),
 PropertyName.LAST_MODIFIED)});
 


Nested Class Summary
static class PropertyNameList.AttributeName
          A name of an attribute.
static class PropertyNameList.NestedPropertyName
          A property name that has a nested property name list.
static class PropertyNameList.PropertyName
          The name of a property of a persistent resource.
 
Field Summary
static PropertyNameList EMPTY_DO_NOT_DETERMINE_RESOURCETYPE
           
 
Constructor Summary
PropertyNameList(PropertyNameList.PropertyName[] propertyNames)
           
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is "equal to" this one.
 PropertyNameList.PropertyName[] getPropertyNames()
          Return the array of property names maintained by this PropertyNameList.
 int hashCode()
          Returns a hash code value for the object.
 java.lang.String toString()
          Return the string representation of the list.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

EMPTY_DO_NOT_DETERMINE_RESOURCETYPE

public static PropertyNameList EMPTY_DO_NOT_DETERMINE_RESOURCETYPE
Constructor Detail

PropertyNameList

public PropertyNameList(PropertyNameList.PropertyName[] propertyNames)
Parameters:
propertyNames - An array of property names.
Method Detail

getPropertyNames

public PropertyNameList.PropertyName[] getPropertyNames()
Return the array of property names maintained by this PropertyNameList.


equals

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

Overrides:
equals in class java.lang.Object
Returns:
true if and only if the specified object is a PropertyNameList whose property names array is equal to the property names array of this ignoring order.

hashCode

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

Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Return the string representation of the list.

Overrides:
toString in class java.lang.Object


Copyright (c) 2003 - Apache Software Foundation