Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> xpn >> xwiki >> [ objects overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.xpn.xwiki.objects
Class BaseCollection  

java.lang.Object
  com.xpn.xwiki.objects.BaseElement
      com.xpn.xwiki.objects.BaseCollection

All Implemented Interfaces:

ElementInterface, ObjectInterface, java.io.Serializable

Direct Known Subclasses:

BaseObject

---

public abstract class BaseCollection

extends BaseElement

implements ObjectInterface, java.io.Serializable

---

Field Summary
private  java.lang.String	className
private  java.util.Map	fields
private  java.util.List	fieldsToRemove
private  int	number

 

Fields inherited from class com.xpn.xwiki.objects.BaseElement

 

Constructor Summary

BaseCollection()

 

Method Summary
void	addField(java.lang.String name, PropertyInterface element)
void	addPropertyForRemoval(PropertyInterface field)
void	checkField(java.lang.String name)
java.lang.Object	clone()           This method may be called to create a new copy of the Object.
boolean	equals(java.lang.Object coll)           Determine whether this Object is semantically equal to another Object.
PropertyInterface	get(java.lang.String name)
java.lang.String	getClassName()
java.util.Date	getDateValue(java.lang.String name)
java.util.List	getDiff(java.lang.Object coll, com.xpn.xwiki.XWikiContext context)
PropertyInterface	getField(java.lang.String name)
java.util.Collection	getFieldList()
private  java.util.Map	getFields()
java.util.List	getFieldsToRemove()
int	getId()
int	getIntValue(java.lang.String name)
java.lang.String	getLargeStringValue(java.lang.String name)
long	getLongValue(java.lang.String name)
int	getNumber()
java.lang.Object[]	getProperties()
java.util.Set	getPropertyList()
java.lang.Object[]	getPropertyNames()
java.util.Set	getSetValue(java.lang.String name)
java.lang.String	getStringValue(java.lang.String name)
com.xpn.xwiki.objects.classes.BaseClass	getxWikiClass(com.xpn.xwiki.XWikiContext context)
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
void	merge(BaseObject object)
void	put(java.lang.String name, PropertyInterface property)
void	removeField(java.lang.String name)
PropertyInterface	safeget(java.lang.String name)
void	safeput(java.lang.String name, PropertyInterface property)
void	setClassName(java.lang.String name)
void	setDateValue(java.lang.String name, java.util.Date value)
void	setFields(java.util.Map fields)
void	setFieldsToRemove(java.util.List fieldsToRemove)
void	setId(int id)
void	setIntValue(java.lang.String name, int value)
void	setLargeStringValue(java.lang.String name, java.lang.String value)
void	setLongValue(java.lang.String name, long value)
void	setNumber(int number)
void	setSetValue(java.lang.String name, java.util.Set value)
void	setStringValue(java.lang.String name, java.lang.String value)
java.lang.String	toString()           Convert this Object to a human-readable String.
abstract  org.dom4j.Element	toXML(com.xpn.xwiki.objects.classes.BaseClass bclass)
java.lang.String	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

className

private java.lang.String className

---

fields

private java.util.Map fields

---

fieldsToRemove

private java.util.List fieldsToRemove

---

number

private int number

Constructor Detail

BaseCollection

public BaseCollection()

Method Detail

getId

public int getId()

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

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

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

setId

public void setId(int id)

---

getNumber

public int getNumber()

---

setNumber

public void setNumber(int number)

---

addPropertyForRemoval

public void addPropertyForRemoval(PropertyInterface field)

---

getClassName

public java.lang.String getClassName()

---

setClassName

public void setClassName(java.lang.String name)

---

checkField

public void checkField(java.lang.String name)
                throws com.xpn.xwiki.XWikiException

---

safeget

public PropertyInterface safeget(java.lang.String name)

Specified by:

safeget in interface ObjectInterface

---

get

public PropertyInterface get(java.lang.String name)
                      throws com.xpn.xwiki.XWikiException

Specified by:

get in interface ObjectInterface

---

safeput

public void safeput(java.lang.String name,
                    PropertyInterface property)

Specified by:

safeput in interface ObjectInterface

---

put

public void put(java.lang.String name,
                PropertyInterface property)
         throws com.xpn.xwiki.XWikiException

Specified by:

put in interface ObjectInterface

---

getxWikiClass

public com.xpn.xwiki.objects.classes.BaseClass getxWikiClass(com.xpn.xwiki.XWikiContext context)

Specified by:

getxWikiClass in interface ObjectInterface

---

getStringValue

public java.lang.String getStringValue(java.lang.String name)

---

getLargeStringValue

public java.lang.String getLargeStringValue(java.lang.String name)

---

setStringValue

public void setStringValue(java.lang.String name,
                           java.lang.String value)

---

setLargeStringValue

public void setLargeStringValue(java.lang.String name,
                                java.lang.String value)

---

getIntValue

public int getIntValue(java.lang.String name)

---

setIntValue

public void setIntValue(java.lang.String name,
                        int value)

---

getLongValue

public long getLongValue(java.lang.String name)

---

setLongValue

public void setLongValue(java.lang.String name,
                         long value)

---

getDateValue

public java.util.Date getDateValue(java.lang.String name)

---

setDateValue

public void setDateValue(java.lang.String name,
                         java.util.Date value)

---

getSetValue

public java.util.Set getSetValue(java.lang.String name)

---

setSetValue

public void setSetValue(java.lang.String name,
                        java.util.Set value)

---

getFields

private java.util.Map getFields()

---

setFields

public void setFields(java.util.Map fields)

---

getField

public PropertyInterface getField(java.lang.String name)

---

addField

public void addField(java.lang.String name,
                     PropertyInterface element)

---

removeField

public void removeField(java.lang.String name)

---

getFieldList

public java.util.Collection getFieldList()

---

getPropertyList

public java.util.Set getPropertyList()

---

getProperties

public java.lang.Object[] getProperties()

---

getPropertyNames

public java.lang.Object[] getPropertyNames()

---

equals

public boolean equals(java.lang.Object coll)

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 BaseElement

---

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 BaseElement

---

merge

public void merge(BaseObject object)

---

getDiff

public java.util.List getDiff(java.lang.Object coll,
                              com.xpn.xwiki.XWikiContext context)

---

getFieldsToRemove

public java.util.List getFieldsToRemove()

---

setFieldsToRemove

public void setFieldsToRemove(java.util.List fieldsToRemove)

---

toXML

public abstract org.dom4j.Element toXML(com.xpn.xwiki.objects.classes.BaseClass bclass)

Specified by:

toXML in interface ObjectInterface

---

toXMLString

public java.lang.String toXMLString()

---

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

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> xpn >> xwiki >> [ objects overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---