incubator-sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cziege...@apache.org
Subject svn commit: r1458799 - in /sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource: ResourceMetadata.java ResourceProvider.java ResourceProviderFactory.java ResourceResolver.java ResourceResolverFactory.java SyntheticResource.java
Date Wed, 20 Mar 2013 12:41:30 GMT
Author: cziegeler
Date: Wed Mar 20 12:41:30 2013
New Revision: 1458799

URL: http://svn.apache.org/r1458799
Log:
Fix some typos in javadoc

Modified:
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceMetadata.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/ResourceProviderFactory.java
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/SyntheticResource.java

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceMetadata.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceMetadata.java?rev=1458799&r1=1458798&r2=1458799&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceMetadata.java
(original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceMetadata.java
Wed Mar 20 12:41:30 2013
@@ -296,6 +296,7 @@ public class ResourceMetadata extends Ha
     /**
      * Make this object read-only. All method calls trying to modify this object
      * result in an exception!
+     * @since 2.3
      */
     public void lock() {
         this.isReadOnly = true;
@@ -350,7 +351,7 @@ public class ResourceMetadata extends Ha
             }
         }
     }
-    
+
     @Override
     public Set<Map.Entry<String, Object>> entrySet() {
         getLockedData();

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=1458799&r1=1458798&r2=1458799&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
Wed Mar 20 12:41:30 2013
@@ -82,9 +82,9 @@ public interface ResourceProvider {
      * <p>
      * This method is called to resolve a resource for the given request.
      * The properties of the request, such as request
-     * parameters, may be use to parametrize the resource resolution. An
-     * example of such parametrization is support for a JSR-311
-     * style resource provider to support the parametrized URL patterns.
+     * parameters, may be use to parameterize the resource resolution. An
+     * example of such parameterization is support for a JSR-311
+     * style resource provider to support the parameterized URL patterns.
      *
      * @param resourceResolver
      *            The {@link ResourceResolver} to which the returned

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProviderFactory.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProviderFactory.java?rev=1458799&r1=1458798&r2=1458799&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProviderFactory.java
(original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceProviderFactory.java
Wed Mar 20 12:41:30 2013
@@ -40,7 +40,7 @@ public interface ResourceProviderFactory
      * A required resource provider factory is accessed directly when a new resource resolver
      * is created. Only if authentication against all required resource provider factories
      * is successful, a resource resolver is created by the resource resolver factory.
-     * Boolean service property, default vaule is <code>false</true>
+     * Boolean service property, default value is <code>false</true>
      */
     String PROPERTY_REQUIRED = "required";
 
@@ -55,11 +55,11 @@ public interface ResourceProviderFactory
      *
      * @param authenticationInfo
      *            A map of further credential information which may be used by
-     *            the implementation to parametrize how the resource provider is
+     *            the implementation to parameterize how the resource provider is
      *            created. This may be <code>null</code>.
      * @return A {@link ResourceProvider} according to the <code>authenticationInfo</code>.
      * @throws LoginException
-     *             If an error occurrs creating the new <code>ResourceProvider</code>
with the
+     *             If an error occurs creating the new <code>ResourceProvider</code>
with the
      *             provided credential data.
      */
     ResourceProvider getResourceProvider(Map<String, Object> authenticationInfo) throws
LoginException;
@@ -81,12 +81,12 @@ public interface ResourceProviderFactory
      *
      * @param authenticationInfo
      *            A map of further credential information which may be used by
-     *            the implementation to parametrize how the resource provider is
+     *            the implementation to parameterize how the resource provider is
      *            created. This may be <code>null</code>.
      * @return A {@link ResourceProvider} with administrative privileges unless
      *         the {@link ResourceResolverFactory#USER_IMPERSONATION} was set in the <code>authenticationInfo</code>.
      * @throws LoginException
-     *             If an error occurrs creating the new <code>ResourceResolverFactory</code>
with the
+     *             If an error occurs creating the new <code>ResourceResolverFactory</code>
with the
      *             provided credential data.
      */
     ResourceProvider getAdministrativeResourceProvider(Map<String, Object> authenticationInfo)
throws LoginException;

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java?rev=1458799&r1=1458798&r2=1458799&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
(original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
Wed Mar 20 12:41:30 2013
@@ -49,7 +49,7 @@ import org.apache.sling.api.adapter.Adap
  * This interface defines two kinds of methods to access resources: The
  * <code>resolve</code> methods and the <code>getResource</code>
methods. The
  * difference lies in the algorithm applied to find the requested resource and
- * in the behaviour in case a resource cannot be found:
+ * in the behavior in case a resource cannot be found:
  * <table>
  * <tr>
  * <th>Method Kind</th>
@@ -144,7 +144,7 @@ public interface ResourceResolver extend
      * @return The {@link Resource} addressed by the <code>absPath</code> or
a
      *         {@link NonExistingResource} if no such resource can be resolved.
      * @throws org.apache.sling.api.SlingException Or a subclass thereof may be
-     *             thrown if an error occurrs trying to resolve the resource.
+     *             thrown if an error occurs trying to resolve the resource.
      * @throws IllegalStateException if this resource resolver has already been
      *             {@link #close() closed}.
      * @since 2.0.4
@@ -173,7 +173,7 @@ public interface ResourceResolver extend
      * @return The {@link Resource} addressed by the <code>absPath</code> or
a
      *         {@link NonExistingResource} if no such resource can be resolved.
      * @throws org.apache.sling.api.SlingException Or a subclass thereof may be
-     *             thrown if an error occurrs trying to resolve the resource.
+     *             thrown if an error occurs trying to resolve the resource.
      * @throws IllegalStateException if this resource resolver has already been
      *             {@link #close() closed}.
      */
@@ -198,7 +198,7 @@ public interface ResourceResolver extend
      * @throws NullPointerException If <code>request</code> is <code>null</code>
      *             .
      * @throws org.apache.sling.api.SlingException Or a subclass thereof may be
-     *             thrown if an error occurrs trying to resolve the resource.
+     *             thrown if an error occurs trying to resolve the resource.
      * @throws IllegalStateException if this resource resolver has already been
      *             {@link #close() closed}.
      * @deprecated as of 2.0.4, use {@link #resolve(HttpServletRequest, String)}
@@ -279,7 +279,7 @@ public interface ResourceResolver extend
      *            relative path to a resource.
      * @return The <code>Resource</code> object loaded from the path or
      *         <code>null</code> if the path does not resolve to a resource.
-     * @throws org.apache.sling.api.SlingException If an error occurrs trying to
+     * @throws org.apache.sling.api.SlingException If an error occurs trying to
      *             load the resource object from the path.
      * @throws IllegalStateException if this resource resolver has already been
      *             {@link #close() closed}.
@@ -307,7 +307,7 @@ public interface ResourceResolver extend
      *            (parent location), which are resolved by this method.
      * @return The <code>Resource</code> object loaded from the path or
      *         <code>null</code> if the path does not resolve to a resource.
-     * @throws org.apache.sling.api.SlingException If an error occurrs trying to
+     * @throws org.apache.sling.api.SlingException If an error occurs trying to
      *             load the resource object from the path or if
      *             <code>base</code> is <code>null</code> and <code>path</code>
      *             is relative.
@@ -382,7 +382,7 @@ public interface ResourceResolver extend
      * <p>
      * The semantic meaning of the query and language depend on the actual
      * implementation and storage used for the resources. For JCR repository
-     * being used as storage, the query and lanuage parameters are used to
+     * being used as storage, the query and language parameters are used to
      * 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.
@@ -396,7 +396,7 @@ public interface ResourceResolver extend
      *         query.
      * @throws QuerySyntaxException If the query is not syntactically correct
      *             according to the query language indicator.
-     * @throws org.apache.sling.api.SlingException If an error occurrs querying
+     * @throws org.apache.sling.api.SlingException If an error occurs querying
      *             for the resources.
      * @throws IllegalStateException if this resource resolver has already been
      *             {@link #close() closed}.
@@ -409,7 +409,7 @@ public interface ResourceResolver extend
      * <p>
      * The semantic meaning of the query and language depend on the actual
      * implementation and storage used for the resources. For JCR repository
-     * being used as storage, the query and lanuage parameters are used to
+     * being used as storage, the query and language parameters are used to
      * create a JCR <code>Query</code> through the <code>QueryManager</code>.
      * The result returned is then based on the <code>RowIterator</code>
      * provided by the query result. The map returned for each row is indexed by
@@ -426,7 +426,7 @@ public interface ResourceResolver extend
      *         access to the query result.
      * @throws QuerySyntaxException If the query is not syntactically correct
      *             according to the query language indicator.
-     * @throws org.apache.sling.api.SlingException If an error occurrs querying
+     * @throws org.apache.sling.api.SlingException If an error occurs querying
      *             for the resources.
      * @throws IllegalStateException if this resource resolver has already been
      *             {@link #close() closed}.
@@ -449,12 +449,12 @@ public interface ResourceResolver extend
      * </pre>
      *
      * @param authenticationInfo The map or credential data to overlay the
-     *            orignal credential data with for the creation of a new
+     *            original credential data with for the creation of a new
      *            resource resolver. This may be <code>null</code> in which case
      *            the same credential data is used as was used to create this
      *            instance.
      * @return A new <code>ResourceResolver</code>
-     * @throws LoginException If an error occurrs creating the new
+     * @throws LoginException If an error occurs creating the new
      *             <code>ResourceResolver</code> with the provided credential
      *             data.
      * @throws IllegalStateException if this resource resolver has already been

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java?rev=1458799&r1=1458798&r2=1458799&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java
(original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java
Wed Mar 20 12:41:30 2013
@@ -80,11 +80,11 @@ public interface ResourceResolverFactory
      * authenticated and only provide minimal privileges, if any at all.
      *
      * @param authenticationInfo A map of further credential information which
-     *            may be used by the implementation to parametrize how the
+     *            may be used by the implementation to parameterize how the
      *            resource resolver is created. This may be <code>null</code>.
      * @return A {@link ResourceResolver} according to the
      *         <code>authenticationInfo</code>.
-     * @throws LoginException If an error occurrs creating the new
+     * @throws LoginException If an error occurs creating the new
      *             <code>ResourceResolver</code> with the provided credential
      *             data.
      */
@@ -108,12 +108,12 @@ public interface ResourceResolverFactory
      * through {@link #getResourceResolver(Map)} must be used.</i></b>
      *
      * @param authenticationInfo A map of further credential information which
-     *            may be used by the implementation to parametrize how the
+     *            may be used by the implementation to parameterize how the
      *            resource resolver is created. This may be <code>null</code>.
      * @return A {@link ResourceResolver} with administrative privileges unless
      *         the {@link #USER_IMPERSONATION} was set in the
      *         <code>authenticationInfo</code>.
-     * @throws LoginException If an error occurrs creating the new
+     * @throws LoginException If an error occurs creating the new
      *             <code>ResourceResolver</code> with the provided credential
      *             data.
      */

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/SyntheticResource.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/SyntheticResource.java?rev=1458799&r1=1458798&r2=1458799&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/SyntheticResource.java
(original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/SyntheticResource.java
Wed Mar 20 12:41:30 2013
@@ -26,7 +26,7 @@ package org.apache.sling.api.resource;
  */
 public class SyntheticResource extends AbstractResource {
 
-    /** The resoure resolver to which this resource is related */
+    /** The resource resolver to which this resource is related */
     private final ResourceResolver resourceResolver;
 
     /** The path of the synthetic resource */
@@ -35,7 +35,7 @@ public class SyntheticResource extends A
     /** The type this synthetic resource assumes */
     private final String resourceType;
 
-    /** The metadata of this resource just containig the resource path */
+    /** The metadata of this resource just containing the resource path */
     private final ResourceMetadata resourceMetadata;
 
     /**



Mime
View raw message