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 2016/07/05 11:13:08 UTC
svn commit: r1751443 - in
/sling/trunk/bundles/api/src/main/java/org/apache/sling/api: request/
resource/
Author: cziegeler
Date: Tue Jul 5 11:13:08 2016
New Revision: 1751443
URL: http://svn.apache.org/viewvc?rev=1751443&view=rev
Log:
SLING-5821 : Fix javadoc errors and warnings (WiP)
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameterMap.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestPathInfo.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestProgressTracker.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestUtil.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/ResponseUtil.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AttributableResourceProvider.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/DynamicResourceProvider.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ParametrizableResourceProvider.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/PersistenceException.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/QueriableResourceProvider.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/RefreshableResourceProvider.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProvider.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameterMap.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameterMap.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameterMap.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameterMap.java Tue Jul 5 11:13:08 2016
@@ -33,12 +33,17 @@ import aQute.bnd.annotation.ProviderType
@ProviderType
public interface RequestParameterMap extends Map<String, RequestParameter[]> {
- /** Returns all values for the named parameter or null if none
+ /**
+ * Returns all values for the named parameter or null if none
+ * @param name The parameter name
+ * @return The request parameter array or {@code null}.
*/
@CheckForNull RequestParameter[] getValues(@Nonnull String name);
- /** Returns the first value for the named parameter or null if none
+ /**
+ * Returns the first value for the named parameter or null if none
+ * @param name The parameter name
+ * @return The request parameter or {@code null}.
*/
@CheckForNull RequestParameter getValue(String name);
-
}
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestPathInfo.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestPathInfo.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestPathInfo.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestPathInfo.java Tue Jul 5 11:13:08 2016
@@ -39,7 +39,7 @@ import aQute.bnd.annotation.ProviderType
* request URI after the content path is a dot, the string after the dot upto
* but not including the last dot before the next slash character or the end of
* the request URI. If the content path spans the complete request URI or if a
- * slash follows the content path in the request, then no seletors exist. If
+ * slash follows the content path in the request, then no selectors exist. If
* only one dot follows the content path before the end of the request URI or
* the next slash, no selectors exist. The selectors are available as
* {@link #getSelectorString() a single string} and as an
@@ -56,7 +56,7 @@ import aQute.bnd.annotation.ProviderType
* path.
* </ol>
* <p>
- * Examples: <table>
+ * Examples: <table summary="">
* <tr>
* <th>URI</th>
* <th>Content Path</th>
@@ -160,6 +160,7 @@ public interface RequestPathInfo {
* Rather it is equal to the
* {@link org.apache.sling.api.resource.ResourceMetadata#RESOLUTION_PATH resolution path metadata property}
* of the resource.
+ * @return The resource path
*/
@Nonnull String getResourcePath();
@@ -181,6 +182,7 @@ public interface RequestPathInfo {
* Decomposition of the request URL is defined in the <a
* href="#decomp">Decomposition of a Request URL</a> above.
*
+ * @return The selector string or {@code null}
* @see #getSelectors()
*/
@CheckForNull String getSelectorString();
@@ -194,6 +196,7 @@ public interface RequestPathInfo {
* Decomposition of the request URL is defined in the <a
* href="#decomp">Decomposition of a Request URL</a> above.
*
+ * @return An array of selectors
* @see #getSelectorString()
*/
@Nonnull String[] getSelectors();
@@ -217,6 +220,7 @@ public interface RequestPathInfo {
* as an argument to the
* {@link org.apache.sling.api.resource.ResourceResolver#getResource(String)}
* method.
+ * @return The suffix resource or {@code null}.
*
* @since 2.3 (Sling API Bundle 2.3.2)
*/
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestProgressTracker.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestProgressTracker.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestProgressTracker.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestProgressTracker.java Tue Jul 5 11:13:08 2016
@@ -85,25 +85,32 @@ import aQute.bnd.annotation.ProviderType
@ProviderType
public interface RequestProgressTracker {
- /** Creates an entry with the given message */
- void log(@Nonnull String message);
+ /**
+ * Creates an entry with the given message
+ * @param message The message
+ */
+ void log(@Nonnull String message);
/**
* Creates an entry with a message constructed from the given
* <code>MessageFormat</code> format evaluated using the given formatting
* arguments.
+ * @param format The message
+ * @param args Arguments for the message
*/
void log(@Nonnull String format, Object... args);
/**
* Starts a named timer. If a timer of the same name already exists, it is
* reset to the current time.
+ * @param timerName the name of the timer
*/
void startTimer(@Nonnull String timerName);
/**
* Logs an entry with the message set to the name of the timer and the
* number of milliseconds elapsed since the timer start.
+ * @param timerName the name of the timer
*/
void logTimer(@Nonnull String timerName);
@@ -111,17 +118,22 @@ public interface RequestProgressTracker
* Logs an entry with the message constructed from the given
* <code>MessageFormat</code> pattern evaluated using the given arguments
* and the number of milliseconds elapsed since the timer start.
+ * @param timerName the name of the timer
+ * @param format The message
+ * @param args Arguments for the message
*/
void logTimer(@Nonnull String timerName, @Nonnull String format, Object... args);
/**
* Returns an <code>Iterator</code> of tracking entries.
* If there are no messages <code>null</code> is returned.
+ * @return An iterator with the messages or {@code null}
*/
@CheckForNull Iterator<String> getMessages();
/**
* Dumps the process timer entries to the given writer, one entry per line.
+ * @param writer Writer to dump to
*/
void dump(@Nonnull PrintWriter writer);
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestUtil.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestUtil.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestUtil.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestUtil.java Tue Jul 5 11:13:08 2016
@@ -27,8 +27,9 @@ import javax.annotation.Nonnull;
import javax.servlet.Servlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
-import org.apache.sling.api.servlets.HttpConstants;
+
import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.servlets.HttpConstants;
/**
* Request related utility methods.
@@ -46,12 +47,12 @@ public class RequestUtil {
* <pre>
* Header = Token { "," Token } .
* Token = name { ";" Parameter } .
- * Paramter = name [ "=" value ] .
+ * Parameter = name [ "=" value ] .
* </pre>
*
* "," and ";" are not allowed within name and value
*
- * @param value
+ * @param value The header value
* @return A Map indexed by the Token names where the values are Map
* instances indexed by parameter name
*/
@@ -86,12 +87,12 @@ public class RequestUtil {
* <pre>
* Header = Token { "," Token } .
* Token = name { ";" "q" [ "=" value ] } .
- * Paramter = .
+ * Parameter = .
* </pre>
*
* "," and ";" are not allowed within name and value
*
- * @param value
+ * @param value The header value
* @return A Map indexed by the Token names where the values are
* <code>Double</code> instances providing the value of the
* <code>q</code> parameter.
@@ -132,6 +133,9 @@ public class RequestUtil {
* <li>Otherwise check the servlet info
* <li>Otherwise use the fully qualified name of the servlet class
* </ol>
+ *
+ * @param servlet The servlet
+ * @return The name of the servlet.
*/
public static @Nonnull String getServletName(@Nonnull Servlet servlet) {
String name = null;
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/ResponseUtil.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/ResponseUtil.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/ResponseUtil.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/ResponseUtil.java Tue Jul 5 11:13:08 2016
@@ -90,7 +90,11 @@ public class ResponseUtil {
}
}
- /** Escape xml text */
+ /**
+ * Escape XML text
+ * @param input The input text
+ * @return The escaped text
+ */
public static String escapeXml(final String input) {
if (input == null) {
return null;
@@ -116,7 +120,10 @@ public class ResponseUtil {
return b.toString();
}
- /** Return a Writer that writes escaped XML text to target
+ /**
+ * Return a Writer that writes escaped XML text to target
+ * @param target writer
+ * @return Wrapped writer escaping XML
*/
public static @Nonnull Writer getXmlEscapingWriter(@Nonnull Writer target) {
return new XmlEscapingWriter(target);
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AbstractResourceVisitor.java Tue Jul 5 11:13:08 2016
@@ -24,8 +24,8 @@ import java.util.Iterator;
* The <code>AbstractResourceVisitor</code> helps in traversing a
* resource tree by decoupling the actual traversal code
* from application code. Concrete subclasses should implement
- * the {@link ResourceVisitor#visit(Resource)} method.
- *
+ * the {@link AbstractResourceVisitor#visit(Resource)} method.
+ *
* @since 2.2 (Sling API Bundle 2.2.0)
*/
public abstract class AbstractResourceVisitor {
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AttributableResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AttributableResourceProvider.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AttributableResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/AttributableResourceProvider.java Tue Jul 5 11:13:08 2016
@@ -35,7 +35,7 @@ import aQute.bnd.annotation.ConsumerType
* @see ResourceResolver#getAttributeNames()
*
* @since 2.2 (Sling API Bundle 2.2.0)
- * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider<T>}
+ * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider}
*/
@Deprecated
@ConsumerType
@@ -45,6 +45,7 @@ public interface AttributableResourcePro
* Returns a collection of attribute names whose value can be retrieved
* calling the {@link #getAttribute(ResourceResolver, String)} method.
*
+ * @param resolver The resource resolver
* @return A collection of attribute names or <code>null</code>
* @throws IllegalStateException if this resource provider has already been
* closed.
@@ -56,6 +57,7 @@ public interface AttributableResourcePro
* if the attribute is not set or not visible (as e.g. security
* sensitive attributes).
*
+ * @param resolver The resource resolver
* @param name
* The name of the attribute to access
* @return The value of the attribute or <code>null</code> if the attribute
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/DynamicResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/DynamicResourceProvider.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/DynamicResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/DynamicResourceProvider.java Tue Jul 5 11:13:08 2016
@@ -38,7 +38,7 @@ import aQute.bnd.annotation.ConsumerType
* @see ResourceProviderFactory#getAdministrativeResourceProvider(java.util.Map)
*
* @since 2.2 (Sling API Bundle 2.2.0)
- * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider<T>}
+ * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider}
*/
@Deprecated
@ConsumerType
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ModifyingResourceProvider.java Tue Jul 5 11:13:08 2016
@@ -42,7 +42,7 @@ import aQute.bnd.annotation.ConsumerType
* @see ResourceProviderFactory#getAdministrativeResourceProvider(java.util.Map)
*
* @since 2.2 (Sling API Bundle 2.2.0)
- * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider<T>}
+ * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider}
*/
@Deprecated
@ConsumerType
@@ -100,6 +100,7 @@ public interface ModifyingResourceProvid
* Are there any transient changes?
*
* @param resolver The current resource resolver.
+ * @return {@code true} if there are pending changes.
*/
boolean hasChanges(ResourceResolver resolver);
}
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ParametrizableResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ParametrizableResourceProvider.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ParametrizableResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ParametrizableResourceProvider.java Tue Jul 5 11:13:08 2016
@@ -35,7 +35,7 @@ import aQute.bnd.annotation.ConsumerType
* {@link ResourceProvider#getResource(ResourceResolver, String)} is called.
*
* @since 2.8.0 (Sling API Bundle 2.9.0)
- * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider<T>}
+ * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider}
*/
@Deprecated
@ConsumerType
@@ -43,7 +43,7 @@ public interface ParametrizableResourceP
/**
* Returns a resource from this resource provider or <code>null</code> if
- * the resource provider cannot find it. The path should have one of the {@link #ROOTS}
+ * the resource provider cannot find it. The path should have one of the {@link ResourceProvider#ROOTS}
* strings as its prefix.
*
* The resource provider must not return cached instances for a resource as
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/PersistenceException.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/PersistenceException.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/PersistenceException.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/PersistenceException.java Tue Jul 5 11:13:08 2016
@@ -21,10 +21,9 @@ package org.apache.sling.api.resource;
import java.io.IOException;
/**
- * This exception will be thrown during the try to persist
+ * This exception will be thrown during the commit to persist
* changes to a {@link PersistableValueMap}, a
- * {@link ModifiableValueMap#update()} or
- * the {@link ResourceResolver}.
+ * {@link ModifiableValueMap} or the {@link ResourceResolver}.
*/
public class PersistenceException extends IOException {
@@ -64,6 +63,8 @@ public class PersistenceException extend
* Create a new persistence exception.
* @param msg Exception message.
* @param cause Exception cause.
+ * @param resourcePath The optional resource path
+ * @param propertyName The optional property name
*/
public PersistenceException(final String msg,
final Throwable cause,
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/QueriableResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/QueriableResourceProvider.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/QueriableResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/QueriableResourceProvider.java Tue Jul 5 11:13:08 2016
@@ -31,7 +31,7 @@ import aQute.bnd.annotation.ConsumerType
* returned through a {@link ResourceProviderFactory}.
*
* @since 2.2 (Sling API Bundle 2.2.0)
- * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider<T>}
+ * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider}
*/
@Deprecated
@ConsumerType
@@ -56,6 +56,7 @@ public interface QueriableResourceProvid
* The result returned is then based on the <code>NodeIterator</code>
* provided by the query result.
*
+ * @param resolver The resource resolver
* @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 {@link Resource} objects matching the
@@ -85,6 +86,7 @@ public interface QueriableResourceProvid
* converted into the respective Java object, such as <code>Boolean</code>
* for a value of property type <em>Boolean</em>.
*
+ * @param resolver The resource resolver
* @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 providing
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/RefreshableResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/RefreshableResourceProvider.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/RefreshableResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/RefreshableResourceProvider.java Tue Jul 5 11:13:08 2016
@@ -35,7 +35,7 @@ import aQute.bnd.annotation.ConsumerType
* @see ResourceProviderFactory#getAdministrativeResourceProvider(java.util.Map)
*
* @since 2.3 (Sling API Bundle 2.4.0)
- * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider<T>}
+ * @deprecated Use the {@link org.apache.sling.spi.resource.provider.ResourceProvider}
*/
@Deprecated
@ConsumerType
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java Tue Jul 5 11:13:08 2016
@@ -64,6 +64,7 @@ public interface Resource extends Adapta
/**
* Returns the absolute path of this resource in the resource tree.
+ * @return The resource path
*/
@Nonnull String getPath();
@@ -71,6 +72,7 @@ public interface Resource extends Adapta
* Returns the name of this resource. The name of a resource is the last
* segment of the {@link #getPath() path}.
*
+ * @return The resource name
* @since 2.1 (Sling API Bundle 2.2.0)
*/
@Nonnull String getName();
@@ -79,6 +81,7 @@ public interface Resource extends Adapta
* Returns the parent resource or <code>null</code> if this resource
* represents the root of the resource tree.
*
+ * @return The parent resource or {@code null}.
* @throws org.apache.sling.api.SlingException If an error occurs trying to
* get the resource object from the path.
* @throws IllegalStateException if the resource resolver has already been
@@ -94,6 +97,7 @@ public interface Resource extends Adapta
* This method is a convenience and returns exactly the same resources as
* calling <code>getResourceResolver().listChildren(resource)</code>.
*
+ * @return An iterator for child resources.
* @throws org.apache.sling.api.SlingException If an error occurs trying to
* get the resource iterator.
* @throws IllegalStateException if the resource resolver has already been
@@ -109,6 +113,7 @@ public interface Resource extends Adapta
* This method is a convenience and returns exactly the same resources as
* calling <code>getResourceResolver().getChildren(resource)</code>.
*
+ * @return An iterable for child resources
* @throws org.apache.sling.api.SlingException If an error occurs trying to
* get the resource iterator.
* @throws IllegalStateException if the resource resolver has already been
@@ -125,6 +130,8 @@ public interface Resource extends Adapta
* This method is a convenience and returns exactly the same resources as
* calling <code>getResourceResolver().getResource(resource, relPath)</code>.
*
+ * @param relPath relative path to the child resource
+ * @return The child resource or {@code null}
* @throws org.apache.sling.api.SlingException If an error occurs trying to
* get the resource object from the path.
* @throws IllegalStateException if the resource resolver has already been
@@ -144,6 +151,7 @@ public interface Resource extends Adapta
* <p>
* If the resource instance represents a resource which is not actually
* existing, this method returns {@link #RESOURCE_TYPE_NON_EXISTING}.
+ * @return The resource type
*/
@Nonnull String getResourceType();
@@ -156,7 +164,7 @@ public interface Resource extends Adapta
* of a resource, it should call {@link ResourceResolver#getParentResourceType(Resource)}.
* @return The super type of the resource or {@code null}.
* @throws IllegalStateException if this resource resolver has already been
- * {@link #close() closed}.
+ * {@link ResourceResolver#close() closed}.
*/
@CheckForNull String getResourceSuperType();
@@ -165,7 +173,7 @@ public interface Resource extends Adapta
*
* @return <code>true</code> if the resource has any child resources
* @throws IllegalStateException if this resource resolver has already been
- * {@link #close() closed}.
+ * {@link ResourceResolver#close() closed}.
* @since 2.4.4 (Sling API Bundle 2.5.0)
*/
boolean hasChildren();
@@ -180,18 +188,19 @@ public interface Resource extends Adapta
* is also returned if <code>resourceType</code> is
* <code>null</code>.
* @throws IllegalStateException if this resource resolver has already been
- * {@link #close() closed}.
+ * {@link ResourceResolver#close() closed}.
* @since 2.1.0 (Sling API Bundle 2.1.0)
*/
boolean isResourceType(String resourceType);
/**
- * Returns the metadata of this resource. The concrete data contained in the
+ * Returns the meta data of this resource. The concrete data contained in the
* {@link ResourceMetadata} object returned is implementation specific
* except for the {@link ResourceMetadata#RESOLUTION_PATH} property which is
* required to be set to the part of the request URI used to resolve the
* resource.
*
+ * @return The resource meta data
* @see ResourceMetadata
*/
@Nonnull ResourceMetadata getResourceMetadata();
@@ -199,6 +208,7 @@ public interface Resource extends Adapta
/**
* Returns the {@link ResourceResolver} from which this resource has been
* retrieved.
+ * @return The resource resolver
*/
@Nonnull ResourceResolver getResourceResolver();
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProvider.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProvider.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProvider.java Tue Jul 5 11:13:08 2016
@@ -109,6 +109,8 @@ public interface ResourceProvider {
* @param resourceResolver
* The {@link ResourceResolver} to which the returned
* {@link Resource} is attached.
+ * @param request The request
+ * @param path The resource path
* @return {@code null} If this provider does not have a resource for
* the path.
* @throws org.apache.sling.api.SlingException
Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java?rev=1751443&r1=1751442&r2=1751443&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java Tue Jul 5 11:13:08 2016
@@ -61,6 +61,7 @@ public interface ValueMap extends Map<St
*
* @param name The name of the property
* @param type The class of the type
+ * @param <T> The class of the type
* @return Return named value converted to type T or <code>null</code> if
* non existing or can't be converted.
*/
@@ -73,6 +74,7 @@ public interface ValueMap extends Map<St
* case.
*
* @param name The name of the property
+ * @param <T> The expected type
* @param defaultValue The default value to use if the named property does
* not exist or cannot be converted to the requested type. The
* default value is also used to define the type to convert the