Author: tmortagne
Date: 2007-11-15 18:42:18 +0100 (Thu, 15 Nov 2007)
New Revision: 5894

Modified:
   
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java
   
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/DefaultSuperDocument.java
   
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java
   
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocument.java
   
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocumentDoesNotExistException.java
Log:
Add some comments for XWiki Architecture V2 refactor.

Modified: 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java
===================================================================
--- 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java
       2007-11-15 17:15:56 UTC (rev 5893)
+++ 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java
       2007-11-15 17:42:18 UTC (rev 5894)
@@ -52,6 +52,7 @@
  * @todo See http://jira.xwiki.org/jira/browse/XWIKI-1571. When that issue is 
applied in XWiki Core
  *       and when this plugin moves to the version of XWiki Core where it was 
applied then remove
  *       this class.
+ * @future XA2 : rename to AbstractClassManager.
  */
 public abstract class AbstractSuperClass implements SuperClass
 {

Modified: 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/DefaultSuperDocument.java
===================================================================
--- 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/DefaultSuperDocument.java
     2007-11-15 17:15:56 UTC (rev 5893)
+++ 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/DefaultSuperDocument.java
     2007-11-15 17:42:18 UTC (rev 5894)
@@ -38,6 +38,7 @@
  * @version $Id: $
  * @see SuperDocument
  * @see SuperClass
+ * @future XA2 : rename to DefaultDocumentObject.
  */
 public class DefaultSuperDocument extends Document implements SuperDocument
 {

Modified: 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java
===================================================================
--- 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java
       2007-11-15 17:15:56 UTC (rev 5893)
+++ 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java
       2007-11-15 17:42:18 UTC (rev 5894)
@@ -37,9 +37,10 @@
  * </ul>
  * 
  * @version $Id: $
- * @todo See http://jira.xwiki.org/jira/browse/XWIKI-1571. When that issue is 
applied in XWiki Core
+ * @todo See http://jira.xwiki.org/jira/browse/XWIKI-1576. When that issue is 
applied in XWiki Core
  *       and when this plugin moves to the version of XWiki Core where it was 
applied then remove
  *       this class.
+ * @future XA2 : rename to ClassManager.
  */
 public interface SuperClass
 {
@@ -281,6 +282,7 @@
      * @throws XWikiException error when getting document from the database.
      * @see #getItemDefaultName(String)
      * @see #getItemDocumentDefaultFullName(String, XWikiContext)
+     * @future XA2 : rename to getDocumentObject.
      */
     SuperDocument getSuperDocument(String itemName, int objectId, boolean 
validate,
         XWikiContext context) throws XWikiException;
@@ -306,6 +308,7 @@
      * @param context the XWiki context.
      * @return a new SuperDocument instance.
      * @throws XWikiException error when calling SuperDocument implementation 
constructor.
+     * @future XA2 : rename to newDocumentObject.
      */
     SuperDocument newSuperDocument(XWikiDocument doc, int objId, XWikiContext 
context)
         throws XWikiException;
@@ -317,6 +320,7 @@
      * @param context the XWiki context.
      * @return a new SuperDocument instance.
      * @throws XWikiException error when calling SuperDocument implementation 
constructor.
+     * @future XA2 : rename to newDocumentObject.
      */
     SuperDocument newSuperDocument(XWikiContext context) throws XWikiException;
 
@@ -330,6 +334,7 @@
      * @return a new SuperDocument instance.
      * @throws XWikiException error when calling SuperDocument implementation 
constructor.
      * @see #getClassFullName()
+     * @future XA2 : rename to newDocumentObject.
      */
     SuperDocument newSuperDocument(String docFullName, int objId, XWikiContext 
context)
         throws XWikiException;
@@ -342,6 +347,7 @@
      * @param context the XWiki context.
      * @return the list of [EMAIL PROTECTED] SuperDocument}.
      * @throws XWikiException error when calling SuperDocument implementation 
constructor.
+     * @future XA2 : rename to newDocumentObjectList.
      */
     List newSuperDocumentList(XWikiDocument documents, XWikiContext context)
         throws XWikiException;
@@ -354,6 +360,7 @@
      * @param context the XWiki context.
      * @return the list of [EMAIL PROTECTED] SuperDocument}.
      * @throws XWikiException error when calling SuperDocument implementation 
constructor.
+     * @future XA2 : rename to newDocumentObjectList.
      */
     List newSuperDocumentList(List documents, XWikiContext context) throws 
XWikiException;
 }

Modified: 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocument.java
===================================================================
--- 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocument.java
    2007-11-15 17:15:56 UTC (rev 5893)
+++ 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocument.java
    2007-11-15 17:42:18 UTC (rev 5894)
@@ -30,6 +30,7 @@
  * 
  * @version $Id: $
  * @see SuperClass
+ * @future XA2 : rename to DocumentObject.
  */
 public interface SuperDocument
 {

Modified: 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocumentDoesNotExistException.java
===================================================================
--- 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocumentDoesNotExistException.java
       2007-11-15 17:15:56 UTC (rev 5893)
+++ 
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocumentDoesNotExistException.java
       2007-11-15 17:42:18 UTC (rev 5894)
@@ -6,6 +6,7 @@
  * Exception when try get [EMAIL PROTECTED] SuperDocument} that does not exist.
  * 
  * @version $Id: $
+ * @future XA2 : rename to tDocumentObjectDoesNotExistException.
  */
 public class SuperDocumentDoesNotExistException extends XWikiException
 {

_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications

Reply via email to