[xwiki-notifications] r7199 - in xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki: . api

[SVN]

Author: vmassol
Date: 2008-01-30 18:28:47 +0100 (Wed, 30 Jan 2008)
New Revision: 7199

Modified:
   xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java
   
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/api/XWiki.java
Log:
Improved javadoc

Modified: 
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java
===================================================================
--- xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java 
2008-01-30 14:00:08 UTC (rev 7198)
+++ xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/XWiki.java 
2008-01-30 17:28:47 UTC (rev 7199)
@@ -5313,6 +5313,14 @@
         return pref.toLowerCase();
     }
 
+    /**
+     * Privileged API to retrieve an object instantiated from groovy code in a 
String.
+     * Note that Groovy scripts compilation is cached.
+     *
+     * @param script the Groovy class definition string (public class MyClass 
{ ... })
+     * @return An object instantiating this class
+     * @throws XWikiException
+     */
     public Object parseGroovyFromString(String script, XWikiContext context)
         throws XWikiException
     {
@@ -5323,6 +5331,15 @@
                 .parseGroovyFromString(script, context);
     }
 
+    /**
+     * Privileged API to retrieve an object instantiated from groovy code in a 
String,
+     * using a classloader including all JAR files located in the passed page 
as attachments.
+     * Note that Groovy scripts compilation is cached
+     *
+     * @param script the Groovy class definition string (public class MyClass 
{ ... })
+     * @return An object instantiating this class
+     * @throws XWikiException
+     */
     public Object parseGroovyFromString(String script, String jarWikiPage, 
XWikiContext context)
         throws XWikiException
     {

Modified: 
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/api/XWiki.java
===================================================================
--- 
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/api/XWiki.java 
    2008-01-30 14:00:08 UTC (rev 7198)
+++ 
xwiki-platform/core/trunk/xwiki-core/src/main/java/com/xpn/xwiki/api/XWiki.java 
    2008-01-30 17:28:47 UTC (rev 7199)
@@ -2495,11 +2495,11 @@
     }
 
     /**
-     * Priviledged API to retrieve an object instanciated from groovy code in 
a String Groovy
-     * scripts compilation is cached
+     * Privileged API to retrieve an object instantiated from groovy code in a 
String.
+     * Note that Groovy scripts compilation is cached.
      * 
-     * @param script script containing a Groovy class definition (public class 
MyClass { ... })
-     * @return An object instanciating this class
+     * @param script the Groovy class definition string (public class MyClass 
{ ... })
+     * @return An object instantiating this class
      * @throws XWikiException
      */
     public Object parseGroovyFromString(String script) throws XWikiException
@@ -2510,16 +2510,17 @@
     }
 
     /**
-     * Priviledged API to retrieve an object instanciated from groovy code in 
a String Groovy
-     * scripts compilation is cached
+     * Privileged API to retrieve an object instantiated from groovy code in a 
String,
+     * using a classloader including all JAR files located in the passed page 
as attachments.
+     * Note that Groovy scripts compilation is cached
      * 
-     * @param fullname // script containing a Groovy class definition (public 
class MyClass { ... })
-     * @return An object instanciating this class
+     * @param script the Groovy class definition string (public class MyClass 
{ ... })
+     * @return An object instantiating this class
      * @throws XWikiException
      */
-    public Object parseGroovyFromPage(String fullname, String jarWikiPage) 
throws XWikiException
+    public Object parseGroovyFromPage(String script, String jarWikiPage) 
throws XWikiException
     {
-        XWikiDocument doc = xwiki.getDocument(fullname, getXWikiContext());
+        XWikiDocument doc = xwiki.getDocument(script, getXWikiContext());
         if (xwiki.getRightService().hasProgrammingRights(doc, 
getXWikiContext()))
             return xwiki.parseGroovyFromString(doc.getContent(), jarWikiPage, 
getXWikiContext());
         return "groovy_missingrights";

_______________________________________________
notifications mailing list
notifications@xwiki.org
http://lists.xwiki.org/mailman/listinfo/notifications