Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.xpn.xwiki.objects
Class ListProperty  view ListProperty download ListProperty.java

java.lang.Object
  extended bycom.xpn.xwiki.objects.BaseElement
      extended bycom.xpn.xwiki.objects.BaseProperty
          extended bycom.xpn.xwiki.objects.ListProperty
All Implemented Interfaces:
ElementInterface, PropertyInterface, java.io.Serializable
Direct Known Subclasses:
DBStringListProperty, StringListProperty

public class ListProperty
extends BaseProperty


Field Summary
protected  java.util.List list
           
 
Fields inherited from class com.xpn.xwiki.objects.BaseProperty
 
Fields inherited from class com.xpn.xwiki.objects.BaseElement
 
Constructor Summary
ListProperty()
           
 
Method Summary
 java.lang.Object clone()
          This method may be called to create a new copy of the Object.
 boolean equals(java.lang.Object obj)
          Determine whether this Object is semantically equal to another Object.
 java.util.List getList()
           
 java.lang.String getTextValue()
           
 java.lang.Object getValue()
           
 void setList(java.util.List list)
           
 void setValue(java.lang.Object value)
           
 java.lang.String toFormString()
           
 java.lang.String toSingleFormString()
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 java.lang.String toText()
           
 org.dom4j.Element toXML()
           
 
Methods inherited from class com.xpn.xwiki.objects.BaseProperty
getClassType, getId, getObject, hashCode, setClassType, setId, setObject, toXMLString
 
Methods inherited from class com.xpn.xwiki.objects.BaseElement
getName, getPrettyName, setName, setPrettyName
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.xpn.xwiki.objects.ElementInterface
getName, setName
 

Field Detail

list

protected java.util.List list
Constructor Detail

ListProperty

public ListProperty()
Method Detail

getValue

public java.lang.Object getValue()
Overrides:
getValue in class BaseProperty

setValue

public void setValue(java.lang.Object value)
Overrides:
setValue in class BaseProperty

getTextValue

public java.lang.String getTextValue()

toText

public java.lang.String toText()
Overrides:
toText in class BaseProperty

toSingleFormString

public java.lang.String toSingleFormString()

toFormString

public java.lang.String toFormString()
Specified by:
toFormString in interface PropertyInterface
Overrides:
toFormString in class BaseProperty

equals

public boolean equals(java.lang.Object obj)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in class BaseProperty

clone

public java.lang.Object clone()
Description copied from class: java.lang.Object
This method may be called to create a new copy of the Object. The typical behavior is as follows:
  • o == o.clone() is false
  • o.getClass() == o.clone().getClass() is true
  • o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object)>Object.equals(Object) 55 .

If the Object you call clone() on does not implement java.lang.Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 

Overrides:
clone in class BaseProperty

getList

public java.util.List getList()

setList

public void setList(java.util.List list)

toXML

public org.dom4j.Element toXML()
Specified by:
toXML in interface PropertyInterface
Overrides:
toXML in class BaseProperty

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Specified by:
toString in interface ElementInterface
Overrides:
toString in class BaseProperty