svn commit: r746880 - /wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java

[th...@apache.org]

Author: thrantal
Date: Mon Feb 23 04:40:50 2009
New Revision: 746880

URL: http://svn.apache.org/viewvc?rev=746880&view=rev
Log:
WICKET-2113: Fixed misleading Javadoc comments to something that is at least not blatantly incorrect :)

Modified:
    wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java?rev=746880&r1=746879&r2=746880&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/Component.java Mon Feb 23 04:40:50 2009
@@ -64,7 +64,7 @@
  * <li><b>Identity </b>- All Components must have a non-null id which is retrieved by calling
  * getId(). The id must be unique within the MarkupContainer that holds the Component, but does not
  * have to be globally unique or unique within a Page's component hierarchy.
- * 
+ *
  * <li><b>Hierarchy </b>- A component has a parent which can be retrieved with {@link #getParent()}.
  * If a component is an instance of MarkupContainer, it may have children. In this way it has a
  * place in the hierarchy of components contained on a given page.
@@ -1625,7 +1625,8 @@
 	}
 
 	/**
-	 * Gets the backing model object; this is shorthand for getModel().getObject().
+	 * Gets the backing model object. Unlike getDefaultModel().getObject(), this method returns
+	 * null for a null model.
 	 * 
 	 * @return The backing model object
 	 */
@@ -3006,7 +3007,9 @@
 	}
 
 	/**
-	 * Sets the backing model object; shorthand for getModel().setObject(object).
+	 * Sets the backing model object. Unlike <code>getDefaultModel().setObject(object)</code>,
+	 * this method checks authorisation and model comparator, and invokes <code>modelChanging</code>
+	 * and <code>modelChanged</code> if the value really changes.
 	 * 
 	 * @param object
 	 *            The object to set