You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2007/10/29 17:22:21 UTC
svn commit: r589722 - in
/incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api:
request/ resource/ scripting/ servlets/
Author: cziegeler
Date: Mon Oct 29 09:22:18 2007
New Revision: 589722
URL: http://svn.apache.org/viewvc?rev=589722&view=rev
Log:
More javadoc fixes.
Modified:
incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestDispatcherOptions.java
incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestParameter.java
incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/resource/ResourceManager.java
incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/scripting/SlingScriptResolver.java
incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
Modified: incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestDispatcherOptions.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestDispatcherOptions.java?rev=589722&r1=589721&r2=589722&view=diff
==============================================================================
--- incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestDispatcherOptions.java (original)
+++ incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestDispatcherOptions.java Mon Oct 29 09:22:18 2007
@@ -23,14 +23,14 @@
import org.apache.sling.api.SlingHttpServletRequest;
/** <code>RequestDispatcherOptions</code> are used in the
- * {@link SlingHttpServletRequest#getRequestDispatcher SlingHttpServletRequest.getRequestDispatcher}
- * method, to give more control on some aspects of the include/forward
+ * {@link SlingHttpServletRequest#getRequestDispatcher(org.apache.sling.api.resource.Resource, RequestDispatcherOptions)}
+ * method, to give more control on some aspects of the include/forward
* mechanism.
- *
+ *
* Typical use cases include:
* <ul>
* <li>
- * Forcing a resource type, to render a Resource in a specific way,
+ * Forcing a resource type, to render a Resource in a specific way,
* like for example <em>render myself in a suitable way for a navigation box</em>.
* </li>
* <li>
@@ -38,31 +38,31 @@
* a "teaser" selector to the request that I'm including here</em>.
* </li>
* </ul>
- *
- * This class currently only inherits from Map, and defines some constants
+ *
+ * This class currently only inherits from Map, and defines some constants
* for well-known options.
*/
public class RequestDispatcherOptions extends HashMap <String,String> {
-
- /** When dispatching, use the value provided by this option as the resource type,
- * instead of the one defined by the {@link Resource}.
+
+ /** When dispatching, use the value provided by this option as the resource type,
+ * instead of the one defined by the {@link org.apache.sling.api.resource.Resource}.
*/
public static final String OPT_FORCE_RESOURCE_TYPE = "forceResourceType";
-
- /** When dispatching, replace {@link RequestPathInfo} selectors by the
+
+ /** When dispatching, replace {@link RequestPathInfo} selectors by the
* value provided by this option.
*/
public static final String OPT_REPLACE_SELECTORS = "replaceSelectors";
-
+
/** When dispatching, add the value provided by this option to the
* {@link RequestPathInfo} selectors.
*/
- public static final String OPT_ADD_SELECTORS = "addSelectors";
+ public static final String OPT_ADD_SELECTORS = "addSelectors";
/** When dispatching, replace the {@link RequestPathInfo} suffix by
* the value provided by this option
*/
- public static final String REPLACE_SUFFIX = "replaceSuffix";
+ public static final String REPLACE_SUFFIX = "replaceSuffix";
}
Modified: incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestParameter.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestParameter.java?rev=589722&r1=589721&r2=589722&view=diff
==============================================================================
--- incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestParameter.java (original)
+++ incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/request/RequestParameter.java Mon Oct 29 09:22:18 2007
@@ -25,20 +25,20 @@
/**
* The <code>RequestParameter</code> class represents a single parameter sent
* with the client request. Instances of this class are returned by the
- * {@link SlingHttpServletRequest#getRequestParameter(String)},
- * {@link SlingHttpServletRequest#getRequestParameters(String)} and
- * {@link SlingHttpServletRequest#getRequestParameterMap()} method.
- *
- * @see SlingHttpServletRequest#getRequestParameter(String)
- * @see SlingHttpServletRequest#getRequestParameters(String)
- * @see SlingHttpServletRequest#getRequestParameterMap()
+ * {@link org.apache.sling.api.SlingHttpServletRequest#getRequestParameter(String)},
+ * {@link org.apache.sling.api.SlingHttpServletRequest#getRequestParameters(String)} and
+ * {@link org.apache.sling.api.SlingHttpServletRequest#getRequestParameterMap()} method.
+ *
+ * @see org.apache.sling.api.SlingHttpServletRequest#getRequestParameter(String)
+ * @see org.apache.sling.api.SlingHttpServletRequest#getRequestParameters(String)
+ * @see org.apache.sling.api.SlingHttpServletRequest#getRequestParameterMap()
*/
public interface RequestParameter {
/**
* Determines whether or not this instance represents a simple form field or
* an uploaded file.
- *
+ *
* @return <code>true</code> if the instance represents a simple form
* field; <code>false</code> if it represents an uploaded file.
*/
@@ -47,7 +47,7 @@
/**
* Returns the content type passed by the browser or <code>null</code> if
* not defined.
- *
+ *
* @return The content type passed by the browser or <code>null</code> if
* not defined.
*/
@@ -55,14 +55,14 @@
/**
* Returns the size in bytes of the parameter.
- *
+ *
* @return The size in bytes of the parameter.
*/
long getSize();
/**
* Returns the contents of the parameter as an array of bytes.
- *
+ *
* @return The contents of the parameter as an array of bytes.
*/
byte[] get();
@@ -70,7 +70,7 @@
/**
* Returns an InputStream that can be used to retrieve the contents of the
* file.
- *
+ *
* @return An InputStream that can be used to retrieve the contents of the
* file.
* @throws IOException if an error occurs.
@@ -82,7 +82,7 @@
* the browser (or other client software). In most cases, this will be the
* base file name, without path information. However, some clients, such as
* the Opera browser, do include path information.
- *
+ *
* @return The original filename in the client's filesystem.
*/
String getFileName();
@@ -91,7 +91,7 @@
* Returns the contents of the parameter as a String, using the default
* character encoding. This method uses {@link #get()} to retrieve the
* contents of the item.
- *
+ *
* @return The contents of the parameter, as a string.
*/
String getString();
@@ -100,7 +100,7 @@
* Returns the contents of the parameter as a String, using the specified
* encoding. This method uses link {@link #get()} to retrieve the contents
* of the item.
- *
+ *
* @param encoding The character encoding to use.
* @return The contents of the parameter, as a string.
* @throws UnsupportedEncodingException if the requested character encoding
Modified: incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/resource/ResourceManager.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/resource/ResourceManager.java?rev=589722&r1=589721&r2=589722&view=diff
==============================================================================
--- incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/resource/ResourceManager.java (original)
+++ incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/resource/ResourceManager.java Mon Oct 29 09:22:18 2007
@@ -191,10 +191,6 @@
* <p>
* This method has no effect if there are no unsaved changes, that is if the
* {@link #hasChanges()} method returns <code>false</code>.
- *
- * @throws SlingException If an error occurrs rolling back the changes. The
- * exception should provide access to any causing throwable the
- * <code>getCause</code> method.
*/
void rollback();
Modified: incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/scripting/SlingScriptResolver.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/scripting/SlingScriptResolver.java?rev=589722&r1=589721&r2=589722&view=diff
==============================================================================
--- incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/scripting/SlingScriptResolver.java (original)
+++ incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/scripting/SlingScriptResolver.java Mon Oct 29 09:22:18 2007
@@ -41,7 +41,7 @@
* through a <code>RequestDispatcher</code> is handled by the Sling Framework.
* <p>
* The servlet resolver service is available from the
- * {@link org.apache.sling.api.helpers.ServiceLocator} using the interface class as
+ * {@link org.apache.sling.api.services.ServiceLocator} using the interface class as
* parameter.
*/
public interface SlingScriptResolver {
Modified: incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java?rev=589722&r1=589721&r2=589722&view=diff
==============================================================================
--- incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java (original)
+++ incubator/sling/trunk/sling-api/src/main/java/org/apache/sling/api/servlets/SlingSafeMethodsServlet.java Mon Oct 29 09:22:18 2007
@@ -31,6 +31,7 @@
import javax.servlet.ServletOutputStream;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.sling.api.HttpStatusCodeException;
@@ -47,9 +48,9 @@
* If any of the default HTTP methods is to be implemented just overwrite the
* respective doXXX method. If additional methods should be supported implement
* appropriate doXXX methods and overwrite the
- * {@link #mayService(HttpServletRequest, HttpServletResponse)} method to
+ * {@link #mayService(SlingHttpServletRequest, SlingHttpServletResponse)} method to
* dispatch to the doXXX methods as appropriate and overwrite the
- * {@link #getAllowedRequestMethods(Set)} to add the new method names.
+ * {@link #getAllowedRequestMethods(Map)} to add the new method names.
* <p>
* Please note, that this base class is intended for applications where data is
* only read. As such, this servlet by itself does not support the <em>POST</em>,
@@ -350,10 +351,10 @@
* @param res The Servlet response
* @throws ServletException If the request is not a HTTP request or
* forwarded from the
- * {@link #service(HttpServletRequest, HttpServletResponse)}
+ * {@link #service(SlingHttpServletRequest, SlingHttpServletResponse)}
* called.
* @throws IOException Forwarded from the
- * {@link #service(HttpServletRequest, HttpServletResponse)}
+ * {@link #service(SlingHttpServletRequest, SlingHttpServletResponse)}
* called.
*/
public void service(ServletRequest req, ServletResponse res)