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 BaseObject  

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

All Implemented Interfaces:

ElementInterface, ObjectInterface, java.io.Serializable

---

public class BaseObject

extends BaseCollection

implements ObjectInterface, java.io.Serializable

---

Field Summary

 

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

 

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

 

Constructor Summary

BaseObject()

 

Method Summary
java.lang.Object	clone()           This method may be called to create a new copy of the Object.
void	displayEdit(java.lang.StringBuffer buffer, java.lang.String name, java.lang.String prefix, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayEdit(java.lang.String name, java.lang.String prefix, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayEdit(java.lang.String name, com.xpn.xwiki.XWikiContext context)
void	displayHidden(java.lang.StringBuffer buffer, java.lang.String name, java.lang.String prefix, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayHidden(java.lang.String name, java.lang.String prefix, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayHidden(java.lang.String name, com.xpn.xwiki.XWikiContext context)
void	displaySearch(java.lang.StringBuffer buffer, java.lang.String name, java.lang.String prefix, com.xpn.xwiki.XWikiContext context)
java.lang.String	displaySearch(java.lang.String name, java.lang.String prefix, com.xpn.xwiki.XWikiContext context)
java.lang.String	displaySearch(java.lang.String name, com.xpn.xwiki.XWikiContext context)
void	displayView(java.lang.StringBuffer buffer, java.lang.String name, java.lang.String prefix, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayView(java.lang.String name, java.lang.String prefix, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayView(java.lang.String name, com.xpn.xwiki.XWikiContext context)
boolean	equals(java.lang.Object obj)           Determine whether this Object is semantically equal to another Object.
void	fromXML(org.dom4j.Element oel)
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
void	setId(int id)
org.dom4j.Element	toXML(com.xpn.xwiki.objects.classes.BaseClass bclass)

 

Methods inherited from class com.xpn.xwiki.objects.BaseCollection

addField, addPropertyForRemoval, checkField, get, getClassName, getDateValue, getDiff, getField, getFieldList, getFieldsToRemove, getId, getIntValue, getLargeStringValue, getLongValue, getNumber, getProperties, getPropertyList, getPropertyNames, getSetValue, getStringValue, getxWikiClass, merge, put, removeField, safeget, safeput, setClassName, setDateValue, setFields, setFieldsToRemove, setIntValue, setLargeStringValue, setLongValue, setNumber, setSetValue, setStringValue, toString, 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.ObjectInterface

get, getxWikiClass, put, safeget, safeput

 

Methods inherited from interface com.xpn.xwiki.objects.ElementInterface

getName, setName, toString

 

Constructor Detail

BaseObject

public BaseObject()

Method Detail

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)

Overrides:

hashCode in class BaseCollection

---

setId

public void setId(int id)

Overrides:

setId in class BaseCollection

---

displayHidden

public void displayHidden(java.lang.StringBuffer buffer,
                          java.lang.String name,
                          java.lang.String prefix,
                          com.xpn.xwiki.XWikiContext context)

---

displaySearch

public void displaySearch(java.lang.StringBuffer buffer,
                          java.lang.String name,
                          java.lang.String prefix,
                          com.xpn.xwiki.XWikiContext context)

---

displayView

public void displayView(java.lang.StringBuffer buffer,
                        java.lang.String name,
                        java.lang.String prefix,
                        com.xpn.xwiki.XWikiContext context)

---

displayEdit

public void displayEdit(java.lang.StringBuffer buffer,
                        java.lang.String name,
                        java.lang.String prefix,
                        com.xpn.xwiki.XWikiContext context)

---

displayHidden

public java.lang.String displayHidden(java.lang.String name,
                                      java.lang.String prefix,
                                      com.xpn.xwiki.XWikiContext context)

---

displaySearch

public java.lang.String displaySearch(java.lang.String name,
                                      java.lang.String prefix,
                                      com.xpn.xwiki.XWikiContext context)

---

displayView

public java.lang.String displayView(java.lang.String name,
                                    java.lang.String prefix,
                                    com.xpn.xwiki.XWikiContext context)

---

displayEdit

public java.lang.String displayEdit(java.lang.String name,
                                    java.lang.String prefix,
                                    com.xpn.xwiki.XWikiContext context)

---

displayHidden

public java.lang.String displayHidden(java.lang.String name,
                                      com.xpn.xwiki.XWikiContext context)

---

displaySearch

public java.lang.String displaySearch(java.lang.String name,
                                      com.xpn.xwiki.XWikiContext context)

---

displayView

public java.lang.String displayView(java.lang.String name,
                                    com.xpn.xwiki.XWikiContext context)

---

displayEdit

public java.lang.String displayEdit(java.lang.String name,
                                    com.xpn.xwiki.XWikiContext context)

---

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 BaseCollection

---

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 BaseCollection

---

toXML

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

Specified by:

toXML in interface ObjectInterface

Specified by:

toXML in class BaseCollection

---

fromXML

public void fromXML(org.dom4j.Element oel)
             throws java.lang.ClassNotFoundException,
                    java.lang.IllegalAccessException,
                    java.lang.InstantiationException

---

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

---