incubator-sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fmesc...@apache.org
Subject svn commit: r762459 - in /incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api: SlingConstants.java adapter/AdapterFactory.java adapter/AdapterManager.java resource/ValueMap.java scripting/SlingScriptHelper.java
Date Mon, 06 Apr 2009 18:57:09 GMT
Author: fmeschbe
Date: Mon Apr  6 18:57:09 2009
New Revision: 762459

URL: http://svn.apache.org/viewvc?rev=762459&view=rev
Log:
JavaDoc fixes

Modified:
    incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/SlingConstants.java
    incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterFactory.java
    incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterManager.java
    incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java
    incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java

Modified: incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/SlingConstants.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/SlingConstants.java?rev=762459&r1=762458&r2=762459&view=diff
==============================================================================
--- incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/SlingConstants.java
(original)
+++ incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/SlingConstants.java
Mon Apr  6 18:57:09 2009
@@ -44,8 +44,8 @@
      * The actual namespace URI depends on the environment. For example a
      * {@link org.apache.sling.api.resource.ResourceResolver} using a JCR
      * repository may define its namespace as
-     * <code><em>NAMESPACE_URI_ROOT + "jcr/sling/1.0"</em></code>.
A JSP tag library for
-     * Sling may define its namespace as
+     * <code><em>NAMESPACE_URI_ROOT + "jcr/sling/1.0"</em></code>.
A JSP
+     * tag library for Sling may define its namespace as
      * <code><em>NAMESPACE_URI_ROOT + "taglib/sling/1.0"</em></code>.
      */
     public static final String NAMESPACE_URI_ROOT = "http://sling.apache.org/";

Modified: incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterFactory.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterFactory.java?rev=762459&r1=762458&r2=762459&view=diff
==============================================================================
--- incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterFactory.java
(original)
+++ incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterFactory.java
Mon Apr  6 18:57:09 2009
@@ -58,21 +58,21 @@
      * parameter is on of the classes listed in the {@link #ADAPTER_CLASSES}
      * service registration properties.
      * <p>
-     * This method may return <code>null</code> if the adaptable object may
-     * not be adapted to the adapter (target) type for any reason. In this case,
-     * the implementation should log a message to the log facility noting the
-     * cause for not being able to adapt.
+     * This method may return <code>null</code> if the adaptable object may not
+     * be adapted to the adapter (target) type for any reason. In this case, the
+     * implementation should log a message to the log facility noting the cause
+     * for not being able to adapt.
      * <p>
-     * Note that the <code>adaptable</code> object is not required to
-     * implement the <code>Adaptable</code> interface, though most of the time
-     * this method is called by means of calling the
-     * {@link org.apache.sling.adapter.SlingAdaptable#adaptTo(Class)} method.
-     *
+     * Note that the <code>adaptable</code> object is not required to implement
+     * the <code>Adaptable</code> interface, though most of the time this method
+     * is called by means of calling the {@link Adaptable#adaptTo(Class)}
+     * method.
+     * 
      * @param <AdapterType> The generic type of the adapter (target) type.
      * @param adaptable The object to adapt to the adapter type.
      * @param type The type to which the object is to be adapted.
-     * @return The adapted object or <code>null</code> if this factory
-     *         instance cannot adapt the object.
+     * @return The adapted object or <code>null</code> if this factory instance
+     *         cannot adapt the object.
      */
     <AdapterType> AdapterType getAdapter(Object adaptable,
             Class<AdapterType> type);

Modified: incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterManager.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterManager.java?rev=762459&r1=762458&r2=762459&view=diff
==============================================================================
--- incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterManager.java
(original)
+++ incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/adapter/AdapterManager.java
Mon Apr  6 18:57:09 2009
@@ -22,8 +22,8 @@
  * The <code>AdapterManager</code> defines the service interface for a manager
  * for object adaption. The adapter manager coordinates the registered
  * {@link AdapterFactory} services on behalf of clients wishing to adapt objects
- * to other types. One such client is the {@link org.apache.sling.adapter.SlingAdaptable}
class, which
- * uses the implementation of this bundle to adapt "itself".
+ * to other types. One such client is the {@link Adaptable} class, which uses
+ * the implementation of this bundle to adapt "itself".
  * <p>
  * This interface is not intended to be implemented by clients.
  */
@@ -33,17 +33,16 @@
      * Returns an adapter object of the requested <code>AdapterType</code> for
      * the given <code>adaptable</code> object.
      * <p>
-     * The <code>adaptable</code> object may be any non-<code>null</code>
-     * object and is not required to implement the <code>Adaptable</code>
-     * interface.
-     *
+     * The <code>adaptable</code> object may be any non-<code>null</code>
object
+     * and is not required to implement the <code>Adaptable</code> interface.
+     * 
      * @param <AdapterType> The generic type of the adapter (target) type.
      * @param adaptable The object to adapt to the adapter type.
      * @param type The type to which the object is to be adapted.
      * @return The adapted object or <code>null</code> if no factory exists to
-     *         adapt the <code>adaptable</code> to the
-     *         <code>AdapterType</code> or if the <code>adaptable</code>
-     *         cannot be adapted for any other reason.
+     *         adapt the <code>adaptable</code> to the <code>AdapterType</code>
+     *         or if the <code>adaptable</code> cannot be adapted for any other
+     *         reason.
      */
     <AdapterType> AdapterType getAdapter(Object adaptable,
             Class<AdapterType> type);

Modified: incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java?rev=762459&r1=762458&r2=762459&view=diff
==============================================================================
--- incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java
(original)
+++ incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ValueMap.java
Mon Apr  6 18:57:09 2009
@@ -24,34 +24,40 @@
 import org.apache.sling.api.wrappers.ValueMapDecorator;
 
 /**
- * The <code>ValueMap</code> is an easy way to access
- * properties of a resource. With most resources you can
- * use {@link Resource#adaptTo(Class)} to adapt the resource
- * to a value map. The various getter methods can be used
- * to get the properties of the resource.
+ * The <code>ValueMap</code> is an easy way to access properties of a resource.
+ * With most resources you can use {@link Resource#adaptTo(Class)} to adapt the
+ * resource to a value map. The various getter methods can be used to get the
+ * properties of the resource.
  */
 public interface ValueMap extends Map<String, Object> {
 
     /**
      * Empty value map
      */
-    final ValueMap EMPTY = new ValueMapDecorator(Collections.<String, Object>emptyMap());
+    final ValueMap EMPTY = new ValueMapDecorator(
+        Collections.<String, Object> emptyMap());
 
     /**
      * Get a named property and convert it into the given type.
+     * 
      * @param name The name of the property
      * @param type 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.
+     * @return Return named value converted to type T or <code>null</code> if
+     *         non existing or can't be converted.
      */
     <T> T get(String name, Class<T> type);
 
     /**
      * Get a named property and convert it into the given type.
+     * 
      * @param name The name of the property
-     * @param type The class of the type
-     * @return Return named value converted to type T or the
-     *         default value if non existing or can't be converted.
+     * @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
+     *            value to. If this is <code>null</code> any existing propert
is
+     *            not converted.
+     * @return Return named value converted to type T or the default value if
+     *         non existing or can't be converted.
      */
     <T> T get(String name, T defaultValue);
 }

Modified: incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java?rev=762459&r1=762458&r2=762459&view=diff
==============================================================================
--- incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
(original)
+++ incubator/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingScriptHelper.java
Mon Apr  6 18:57:09 2009
@@ -44,9 +44,7 @@
     SlingHttpServletResponse getResponse();
 
     /**
-     * Returns the {@link SlingScript} being called to handle the request. This
-     * is the same instance as given to the {@link javax.script.ScriptEngine}
-     * for evaluation.
+     * Returns the {@link SlingScript} being called to handle the request.
      */
     SlingScript getScript();
 



Mime
View raw message