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 BaseElement  

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

Direct Known Subclasses:

BaseCollection, BaseProperty

---

public abstract class BaseElement

extends java.lang.Object

---

Field Summary
private  java.lang.String	name
private  java.lang.String	prettyName

 

Constructor Summary

BaseElement()

 

Method Summary
java.lang.Object	clone()           This method may be called to create a new copy of the Object.
boolean	equals(java.lang.Object el)           Determine whether this Object is semantically equal to another Object.
java.lang.String	getName()
java.lang.String	getPrettyName()
void	setName(java.lang.String name)
void	setPrettyName(java.lang.String name)

 

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

name

private java.lang.String name

---

prettyName

private java.lang.String prettyName

Constructor Detail

BaseElement

public BaseElement()

Method Detail

getName

public java.lang.String getName()

---

setName

public void setName(java.lang.String name)

---

getPrettyName

public java.lang.String getPrettyName()

---

setPrettyName

public void setPrettyName(java.lang.String name)

---

equals

public boolean equals(java.lang.Object el)

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.

---

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());
     }
 }
 

---

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

---