Author: cziegeler
Date: Wed Dec 3 07:46:37 2008
New Revision: 722939
URL: http://svn.apache.org/viewvc?rev=722939&view=rev
Log:
SLING-752 - Note difference between resolve and getResource
Modified:
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
Modified:
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
URL:
http://svn.apache.org/viewvc/incubator/sling/trunk/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java?rev=722939&r1=722938&r2=722939&view=diff
==============================================================================
---
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
(original)
+++
incubator/sling/trunk/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
Wed Dec 3 07:46:37 2008
@@ -54,7 +54,7 @@
* method is, that this method may take request properties like the scheme,
* the host header or request parameters into account to resolve the
* resource.
- *
+ *
* @param request The http servlet request object providing more hints at
* how to resolve the <code>absPath</code>. This parameter may
* be <code>null</code> in which case the implementation should
@@ -87,7 +87,7 @@
* the [EMAIL PROTECTED] #resolve(HttpServletRequest, String)} where the
* <code>absPath</code> argument is the result of calling the
* <code>getPathInfo()</code> on the <code>request</code> object.
- *
+ *
* @param request The http servlet request object used to resolve the
* resource for. This must not be <code>null</code>.
* @return The [EMAIL PROTECTED] Resource} addressed by
@@ -100,6 +100,7 @@
* @deprecated as of 2.0.4, use [EMAIL PROTECTED]
#resolve(HttpServletRequest, String)}
* instead.
*/
+ @Deprecated
Resource resolve(HttpServletRequest request);
/**
@@ -115,7 +116,7 @@
* <p>
* If the <code>absPath</code> is a relative path, this method returns
* <code>null</code>.
- *
+ *
* @param absPath The absolute path to be resolved to a resource. If the
* path is relative <code>null</code> is returned. This
* parameter must not be <code>null</code>.
@@ -143,7 +144,7 @@
* <p>
* This method is intended as the reverse operation of the
* [EMAIL PROTECTED] #resolve(String)} method.
- *
+ *
* @param resourcePath The path for which to return a mapped path.
* @return The mapped path.
*/
@@ -167,7 +168,7 @@
* [EMAIL PROTECTED] #resolve(HttpServletRequest, String)} method. As such
the URL
* returned is expected to be an absolute URL including scheme, host, any
* servlet context path and the actual path used to resolve the resource.
- *
+ *
* @param request The http servlet request object which may be used to
apply
* more mapping functionality.
* @param resourcePath The path for which to return a mapped path.
@@ -184,7 +185,10 @@
* a Java Content Repository, the path could be a
* <code>javax.jcr.Item</code> path from which the resource object is
* loaded.
- *
+ * In contrast to the [EMAIL PROTECTED] #resolve(String)} method, this
method
+ * does not apply any logic to the path, so the path is used as-is to
+ * fetch the content.
+ *
* @param path The absolute path to the resource object to be loaded. The
* path may contain relative path specifiers like <code>.</code>
* (current location) and <code>..</code> (parent location),
@@ -207,7 +211,7 @@
* a Java Content Repository, the path could be a
* <code>javax.jcr.Item</code> path from which the resource object is
* loaded.
- *
+ *
* @param base The base [EMAIL PROTECTED] Resource} against which a
relative path
* argument given by <code>path</code> is resolved. This
* parameter may be <code>null</code> if the <code>path</code>
@@ -253,7 +257,7 @@
* reading content from a Java Content Repository, the children could be
the
* [EMAIL PROTECTED] Resource} objects loaded from child items of the
<code>Item</code>
* of the given <code>Resource</code>.
- *
+ *
* @param parent The [EMAIL PROTECTED] Resource Resource} whose children
are requested.
* @return An <code>Iterator</code> of [EMAIL PROTECTED] Resource} objects.
* @throws NullPointerException If <code>parent</code> is
@@ -273,7 +277,7 @@
* create a JCR <code>Query</code> through the <code>QueryManager</code>.
* The result returned is then based on the <code>NodeIterator</code>
* provided by the query result.
- *
+ *
* @param query The query string to use to find the resources.
* @param language The language in which the query is formulated.
* @return An <code>Iterator</code> of [EMAIL PROTECTED] Resource} objects
matching
@@ -299,7 +303,7 @@
* the column name and the column value is the JCR <code>Value</code>
* object converted into the respective Java object, such as
* <code>Boolean</code> for a value of property type <em>Boolean</em>.
- *
+ *
* @param query The query string to use to find the resources.
* @param language The language in which the query is formulated.
* @return An <code>Iterator</code> of <code>Map</code> instances
