Author: cziegeler
Date: Fri May 30 02:01:11 2008
New Revision: 661602
URL: http://svn.apache.org/viewvc?rev=661602&view=rev
Log:
SLING-483: Fix javadoc errors (WiP)
Modified:
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScript.java
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
Modified:
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
URL:
http://svn.apache.org/viewvc/incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java?rev=661602&r1=661601&r2=661602&view=diff
==============================================================================
---
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
(original)
+++
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
Fri May 30 02:01:11 2008
@@ -152,7 +152,7 @@
}
/**
- * Helper method which invokes [EMAIL PROTECTED] #put(String, Object)}
only if the value is not null.
+ * Helper method which invokes [EMAIL PROTECTED] #put(Object, Object)}
only if the value is not null.
*/
protected void safePut(final String key, final Object value) {
if ( value != null ) {
Modified:
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScript.java
URL:
http://svn.apache.org/viewvc/incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScript.java?rev=661602&r1=661601&r2=661602&view=diff
==============================================================================
---
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScript.java
(original)
+++
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScript.java
Fri May 30 02:01:11 2008
@@ -61,7 +61,7 @@
* evaluating the script. Any bound variables must conform to
the
* requirements of the [EMAIL PROTECTED] SlingBindings}
predefined variables
* set.
- * @param name The name of the method to call.
+ * @param method The name of the method to call.
* @param args The arguments for the method call.
* @return The value returned by the method from the script.
* @throws ScriptEvaluationException If an error occurrs executing the
Modified:
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
URL:
http://svn.apache.org/viewvc/incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java?rev=661602&r1=661601&r2=661602&view=diff
==============================================================================
---
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
(original)
+++
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
Fri May 30 02:01:11 2008
@@ -120,15 +120,15 @@
/**
* Lookup a single service
*
- * @param serviceName The name (interface) of the service.
+ * @param serviceType The type (interface) of the service.
* @return The service instance, or null if the service is not available.
*/
- <ServiceType> ServiceType getService(Class<ServiceType> type);
+ <ServiceType> ServiceType getService(Class<ServiceType> serviceType);
/**
* Lookup one or several services
*
- * @param serviceName The name (interface) of the service.
+ * @param serviceType The type (interface) of the service.
* @param filter An optional filter (LDAP-like, see OSGi spec)
* @return The services object or null.
* @throws InvalidServiceFilterSyntaxException If the <code>filter</code>
Modified:
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
URL:
http://svn.apache.org/viewvc/incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java?rev=661602&r1=661601&r2=661602&view=diff
==============================================================================
---
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
(original)
+++
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingAllMethodsServlet.java
Fri May 30 02:01:11 2008
@@ -34,7 +34,7 @@
* exceptions according to the intentions of the Servlet API rather than
* throwing their Sling RuntimeException counter parts. This is done to easy
the
* integration with traditional servlets.
- *
+ *
* @see SlingSafeMethodsServlet for more information on supporting more HTTP
* methods
*/
@@ -42,7 +42,7 @@
/**
* Called by the
- * [EMAIL PROTECTED] #mayService(HttpServletRequest, HttpServletResponse)}
method to
+ * [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)} method to
* handle an HTTP <em>POST</em> request.
* <p>
* This default implementation reports back to the client that the method
is
@@ -50,7 +50,7 @@
* <p>
* Implementations of this class should overwrite this method with their
* implementation for the HTTP <em>POST</em> method support.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response
* @throws ServletException Not thrown by this implementation.
@@ -65,7 +65,7 @@
/**
* Called by the
- * [EMAIL PROTECTED] #mayService(HttpServletRequest, HttpServletResponse)}
method to
+ * [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)} method to
* handle an HTTP <em>PUT</em> request.
* <p>
* This default implementation reports back to the client that the method
is
@@ -73,7 +73,7 @@
* <p>
* Implementations of this class should overwrite this method with their
* implementation for the HTTP <em>PUT</em> method support.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response
* @throws ServletException Not thrown by this implementation.
@@ -88,7 +88,7 @@
/**
* Called by the
- * [EMAIL PROTECTED] #mayService(HttpServletRequest, HttpServletResponse)}
method to
+ * [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)} method to
* handle an HTTP <em>DELETE</em> request.
* <p>
* This default implementation reports back to the client that the method
is
@@ -96,7 +96,7 @@
* <p>
* Implementations of this class should overwrite this method with their
* implementation for the HTTP <em>DELETE</em> method support.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response
* @throws ServletException Not thrown by this implementation.
@@ -118,7 +118,7 @@
* <em>POST</em>, <em>PUT</em> and <em>DELETE</em> and returns
* <code>true</code> if any of these methods is requested. Otherwise
* <code>false</code> is just returned.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response
* @return <code>true</code> if the requested method
(<code>request.getMethod()</code>)
@@ -156,7 +156,7 @@
/**
* Helper method called by
- * [EMAIL PROTECTED] #doOptions(HttpServletRequest, HttpServletResponse)}
to calculate
+ * [EMAIL PROTECTED] #doOptions(SlingHttpServletRequest,
SlingHttpServletResponse)} to calculate
* the value of the <em>Allow</em> header sent as the response to the HTTP
* <em>OPTIONS</em> request.
* <p>
@@ -164,7 +164,7 @@
* support for the <em>POST</em>, <em>PUT</em> and <em>DELETE</em>
* methods in addition to the methods returned by the base class
* implementation.
- *
+ *
* @param declaredMethods The public and protected methods declared in the
* extension of this class.
* @return A <code>StringBuffer</code> containing the list of HTTP methods
@@ -196,7 +196,7 @@
* <p>
* This method may be used to make sure a method is actually overwritten
and
* not just the default implementation.
- *
+ *
* @param method The Method to check
* @param className The name of class assumed to contained the initial
* declaration of the method.
Modified:
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
URL:
http://svn.apache.org/viewvc/incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java?rev=661602&r1=661601&r2=661602&view=diff
==============================================================================
---
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
(original)
+++
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
Fri May 30 02:01:11 2008
@@ -64,7 +64,7 @@
* exceptions according to the intentions of the Servlet API rather than
* throwing their Sling RuntimeException counter parts. This is done to easy
the
* integration with traditional servlets.
- *
+ *
* @see SlingAllMethodsServlet
*/
public class SlingSafeMethodsServlet extends GenericServlet {
@@ -73,18 +73,18 @@
* Handles the <em>HEAD</em> method.
* <p>
* This base implementation just calls the
- * [EMAIL PROTECTED] #doGet(HttpServletRequest, HttpServletResponse)}
method dropping
+ * [EMAIL PROTECTED] #doGet(SlingHttpServletRequest,
SlingHttpServletResponse)} method dropping
* the output. Implementations of this class may overwrite this method if
* they have a more performing implementation. Otherwise, they may just
keep
* this base implementation.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response which only gets the headers set
* @throws ServletException Forwarded from the
- * [EMAIL PROTECTED] #doGet(HttpServletRequest,
HttpServletResponse)}
+ * [EMAIL PROTECTED] #doGet(SlingHttpServletRequest,
SlingHttpServletResponse)}
* method called by this implementation.
* @throws IOException Forwarded from the
- * [EMAIL PROTECTED] #doGet(HttpServletRequest,
HttpServletResponse)}
+ * [EMAIL PROTECTED] #doGet(SlingHttpServletRequest,
SlingHttpServletResponse)}
* method called by this implementation.
*/
protected void doHead(SlingHttpServletRequest request,
@@ -103,7 +103,7 @@
/**
* Called by the
- * [EMAIL PROTECTED] #mayService(HttpServletRequest, HttpServletResponse)}
method to
+ * [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)} method to
* handle an HTTP <em>GET</em> request.
* <p>
* This default implementation reports back to the client that the method
is
@@ -111,7 +111,7 @@
* <p>
* Implementations of this class should overwrite this method with their
* implementation for the HTTP <em>GET</em> method support.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response
* @throws ServletException Not thrown by this implementation.
@@ -136,7 +136,7 @@
* [EMAIL PROTECTED] #getAllowedRequestMethods(Map)} method with the
methods gathered.
* The returned value is then used as the value of the <code>Allow</code>
* header set.
- *
+ *
* @param request The HTTP request object. Not used.
* @param response The HTTP response object on which the header is set.
* @throws ServletException Not thrown by this implementation.
@@ -156,7 +156,7 @@
* <p>
* Extensions of this class do not generally need to overwrite this method
* as it contains all there is to be done to the <em>TRACE</em> method.
- *
+ *
* @param request The HTTP request whose headers are returned.
* @param response The HTTP response into which the request headers are
* written.
@@ -201,7 +201,7 @@
}
/**
- * Called by the [EMAIL PROTECTED] #service(HttpServletRequest,
HttpServletResponse)}
+ * Called by the [EMAIL PROTECTED] #service(SlingHttpServletRequest,
SlingHttpServletResponse)}
* method to handle a request for an HTTP method, which is not known and
* handled by this class or its extension.
* <p>
@@ -210,10 +210,10 @@
* <p>
* This method should be overwritten with great care. It is better to
* overwrite the
- * [EMAIL PROTECTED] #mayService(HttpServletRequest, HttpServletResponse)}
method and
+ * [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)} method and
* add support for any extension HTTP methods through an additional doXXX
* method.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response
* @throws ServletException Not thrown by this implementation.
@@ -240,7 +240,7 @@
* call this base implementation and in case <code>false</code> is
* returned add handling for any other method and of course return whether
* the requested method was known or not.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response
* @return <code>true</code> if the requested method
(<code>request.getMethod()</code>)
@@ -278,7 +278,7 @@
* unhandled HTTP request method. In case of HTTP/1.1 a 405 status code
* (Method Not Allowed) is returned, otherwise a 400 status (Bad Request)
is
* returned.
- *
+ *
* @param request The HTTP request from which the method and protocol
values
* are extracted to build the appropriate message.
* @param response The HTTP response to which the error status is sent.
@@ -305,29 +305,29 @@
/**
* Called by the [EMAIL PROTECTED] #service(ServletRequest,
ServletResponse)} method to
* handle the HTTP request. This implementation calls the
- * [EMAIL PROTECTED] #mayService(HttpServletRequest, HttpServletResponse)}
method and
+ * [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)} method and
* depedending on its return value call the
- * [EMAIL PROTECTED] #doGeneric(HttpServletRequest, HttpServletResponse)}
method. If
- * the [EMAIL PROTECTED] #mayService(HttpServletRequest,
HttpServletResponse)} method
+ * [EMAIL PROTECTED] #doGeneric(SlingHttpServletRequest,
SlingHttpServletResponse)} method. If
+ * the [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)} method
* can handle the request, the
- * [EMAIL PROTECTED] #doGeneric(HttpServletRequest, HttpServletResponse)}
method is not
+ * [EMAIL PROTECTED] #doGeneric(SlingHttpServletRequest,
SlingHttpServletResponse)} method is not
* called otherwise it is called.
* <p>
* Implementations of this class should not generally overwrite this
method.
- * Rather the [EMAIL PROTECTED] #mayService(HttpServletRequest,
HttpServletResponse)}
+ * Rather the [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)}
* method should be overwritten to add support for more HTTP methods.
- *
+ *
* @param request The HTTP request
* @param response The HTTP response
* @throws ServletException Forwarded from the
- * [EMAIL PROTECTED] #mayService(HttpServletRequest,
HttpServletResponse)}
+ * [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)}
* or
- * [EMAIL PROTECTED] #doGeneric(HttpServletRequest,
HttpServletResponse)}
+ * [EMAIL PROTECTED] #doGeneric(SlingHttpServletRequest,
SlingHttpServletResponse)}
* methods.
* @throws IOException Forwarded from the
- * [EMAIL PROTECTED] #mayService(HttpServletRequest,
HttpServletResponse)}
+ * [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)}
* or
- * [EMAIL PROTECTED] #doGeneric(HttpServletRequest,
HttpServletResponse)}
+ * [EMAIL PROTECTED] #doGeneric(SlingHttpServletRequest,
SlingHttpServletResponse)}
* methods.
*/
protected void service(SlingHttpServletRequest request,
@@ -349,7 +349,7 @@
* method if the request is a HTTP request.
* <p>
* Implementations of this class will not generally overwrite this method.
- *
+ *
* @param req The Servlet request
* @param res The Servlet response
* @throws ServletException If the request is not a HTTP request or
@@ -385,7 +385,7 @@
/**
* Helper method called by
- * [EMAIL PROTECTED] #doOptions(HttpServletRequest, HttpServletResponse)}
to calculate
+ * [EMAIL PROTECTED] #doOptions(SlingHttpServletRequest,
SlingHttpServletResponse)} to calculate
* the value of the <em>Allow</em> header sent as the response to the HTTP
* <em>OPTIONS</em> request.
* <p>
@@ -396,10 +396,10 @@
* <p>
* Implementations of this class may overwrite this method check for more
* methods supported by the extension (generally the same list as used in
- * the [EMAIL PROTECTED] #mayService(HttpServletRequest,
HttpServletResponse)} method).
+ * the [EMAIL PROTECTED] #mayService(SlingHttpServletRequest,
SlingHttpServletResponse)} method).
* This base class implementation should always be called to make sure the
* default HTTP methods are included in the list.
- *
+ *
* @param declaredMethods The public and protected methods declared in the
* extension of this class.
* @return A <code>StringBuffer</code> containing the list of HTTP methods
@@ -430,12 +430,12 @@
/**
* Returns a map of methods declared by the class indexed by method name.
* This method is called by the
- * [EMAIL PROTECTED] #doOptions(HttpServletRequest, HttpServletResponse)}
method to
+ * [EMAIL PROTECTED] #doOptions(SlingHttpServletRequest,
SlingHttpServletResponse)} method to
* find the methods to be checked by the
* [EMAIL PROTECTED] #getAllowedRequestMethods(Map)} method. Note, that
only extension
* classes of this class are considered to be sure to not account for the
* default implementations of the doXXX methods in this class.
- *
+ *
* @param c The <code>Class</code> to get the declared methods from
* @return The Map of methods considered for support checking.
*/
