This is an automated email from the ASF dual-hosted git repository.
sseifert pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-resourceresolver.git
The following commit(s) were added to refs/heads/master by this push:
new 26573cf fix javadoc errors
26573cf is described below
commit 26573cf274c604bb49cf4d4b4bb5109b22e92a3b
Author: Stefan Seifert <[email protected]>
AuthorDate: Mon Apr 12 22:15:58 2021 +0200
fix javadoc errors
---
.../impl/helper/ResourceResolverControl.java | 19 +-
.../resourceresolver/impl/helper/StarResource.java | 2 +-
.../sling/resourceresolver/impl/helper/URI.java | 342 +++++++++++----------
.../impl/mapping/MapEntriesHandler.java | 50 ++-
4 files changed, 208 insertions(+), 205 deletions(-)
diff --git
a/src/main/java/org/apache/sling/resourceresolver/impl/helper/ResourceResolverControl.java
b/src/main/java/org/apache/sling/resourceresolver/impl/helper/ResourceResolverControl.java
index 2eefd39..d15ea3c 100644
---
a/src/main/java/org/apache/sling/resourceresolver/impl/helper/ResourceResolverControl.java
+++
b/src/main/java/org/apache/sling/resourceresolver/impl/helper/ResourceResolverControl.java
@@ -45,7 +45,6 @@ import org.apache.sling.api.resource.SyntheticResource;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.api.resource.path.PathBuilder;
import
org.apache.sling.resourceresolver.impl.providers.ResourceProviderHandler;
-import org.apache.sling.resourceresolver.impl.providers.ResourceProviderInfo;
import
org.apache.sling.resourceresolver.impl.providers.ResourceProviderStorage;
import
org.apache.sling.resourceresolver.impl.providers.ResourceProviderStorageProvider;
import
org.apache.sling.resourceresolver.impl.providers.stateful.AuthenticatedResourceProvider;
@@ -62,8 +61,8 @@ import org.slf4j.LoggerFactory;
/**
* This class takes a number of {@link AuthenticatedResourceProvider} objects
and
* exposes it as one such object. Provider appropriate for the given operation
- * is chosen basing on its {@link ResourceProviderInfo#getPath()} (more
specific
- * first) and service ranking.
+ * is chosen basing on its {@link
org.apache.sling.resourceresolver.impl.providers.ResourceProviderInfo#getPath()}
+ * (more specific first) and service ranking.
*
* Like a resource resolver itself, this class is not thread safe.
*/
@@ -177,7 +176,7 @@ public class ResourceResolverControl {
*
* In some cases the {@link SyntheticResource} can be returned if no
* resource provider returns parent for this child. See
- * {@link #getResource(String, Resource, Map, boolean)} for more details
+ * {@link #getResource(ResourceResolverContext, String, Resource, Map,
boolean)} for more details
*/
public Resource getParent(@NotNull final ResourceResolverContext context,
@NotNull final String parentPath, @NotNull final Resource child) {
final AuthenticatedResourceProvider childProvider =
getBestMatchingProvider(context, child.getPath());
@@ -202,7 +201,7 @@ public class ResourceResolverControl {
/**
* Returns resource from the most appropriate resource provider.
- * <br/><br/>
+ * <p>
* If there's no such provider and the path is a part of some resource
* provider path, then the {@link SyntheticResource} will be returned. For
* instance, if we have resource provider under
@@ -210,9 +209,11 @@ public class ResourceResolverControl {
* returns a resource for {@code /libs/sling/servlet/default}, then the
* {@link SyntheticResource} will be returned to provide a consistent
* resource tree.
- * <br/><br/>
- * The same behaviour occurs in {@link #getParent(Resource)} and
- * {@link #listChildren(Resource)}.
+ * </p>
+ * <p>
+ * The same behaviour occurs in {@link #getParent(ResourceResolverContext,
String, Resource)} and
+ * {@link #listChildren(ResourceResolverContext, Resource)}.
+ * </p>
*/
public Resource getResource(final ResourceResolverContext context,
String path, Resource parent, Map<String, String> parameters,
@@ -252,7 +253,7 @@ public class ResourceResolverControl {
/**
* This method asks all matching resource providers for the children
iterators,
* merges them, adds {@link SyntheticResource}s (see
- * {@link #getResource(String, Resource, Map, boolean)} for more details),
+ * {@link #getResource(ResourceResolverContext, String, Resource, Map,
boolean)} for more details),
* filters out the duplicates and returns the resulting iterator. All
* transformations are done lazily, during the {@link Iterator#hasNext()}
* invocation on the result.
diff --git
a/src/main/java/org/apache/sling/resourceresolver/impl/helper/StarResource.java
b/src/main/java/org/apache/sling/resourceresolver/impl/helper/StarResource.java
index 74f148d..75b3bfd 100644
---
a/src/main/java/org/apache/sling/resourceresolver/impl/helper/StarResource.java
+++
b/src/main/java/org/apache/sling/resourceresolver/impl/helper/StarResource.java
@@ -70,7 +70,7 @@ public class StarResource extends SyntheticResource {
}
/**
- * Calls {@link ResourceUtil#getResourceSuperType(ResourceResolver,
String)}
+ * Calls {@link
org.apache.sling.api.resource.ResourceUtil#getResourceSuperType(ResourceResolver,
String)}
* method to dynamically resolve the resource super type of this star
* resource.
*/
diff --git
a/src/main/java/org/apache/sling/resourceresolver/impl/helper/URI.java
b/src/main/java/org/apache/sling/resourceresolver/impl/helper/URI.java
index ec1caae..2df7eb2 100644
--- a/src/main/java/org/apache/sling/resourceresolver/impl/helper/URI.java
+++ b/src/main/java/org/apache/sling/resourceresolver/impl/helper/URI.java
@@ -36,17 +36,17 @@ import org.apache.sling.api.SlingException;
* This class has the purpose of supportting of parsing a URI reference to
* extend any specific protocols, the character encoding of the protocol to be
* transported and the charset of the document.
- *
+ *
* A URI is always in an "escaped" form, since escaping or unescaping a
* completed URI might change its semantics.
- *
+ *
* Implementers should be careful not to escape or unescape the same string
more
* than once, since unescaping an already unescaped string might lead to
* misinterpreting a percent data character as another escaped character, or
* vice versa in the case of escaping an already escaped string.
- *
+ *
* In order to avoid these problems, data types used as follows:
- *
+ *
* <blockquote>
*
* <pre>
@@ -56,17 +56,17 @@ import org.apache.sling.api.SlingException;
* </pre>
*
* </blockquote>
- *
+ *
* So, a URI is a sequence of characters as an array of a char type, which is
* not always represented as a sequence of octets as an array of byte.
- *
+ *
* URI Syntactic Components
- *
+ *
* <blockquote>
*
* <pre>
* - In general, written as follows:
- * Absolute URI = <scheme>:<scheme-specific-part>
+ * Absolute URI = <scheme><scheme-specific-part>
* Generic URI = <scheme>://<authority><path>?<query>
* - Syntax
* absoluteURI = scheme ":" ( hier_part | opaque_part )
@@ -76,7 +76,7 @@ import org.apache.sling.api.SlingException;
* </pre>
*
* </blockquote>
- *
+ *
* The following examples illustrate URI that are in common use.
*
* <pre>
@@ -96,9 +96,9 @@ import org.apache.sling.api.SlingException;
*
* Please, notice that there are many modifications from URL(RFC 1738) and
* relative URL(RFC 1808).
- *
+ *
* <b>The expressions for a URI</b>
- *
+ *
*
* <pre>
* For escaped URI forms
@@ -106,12 +106,12 @@ import org.apache.sling.api.SlingException;
* - char[] getRawXxx() // method
* - String getEscapedXxx() // method
* - String toString() // method
- *
+ *
* For unescaped URI forms
* - URI(String) // constructor
* - String getXXX() // method
* </pre>
- *
+ *
* This class is a slightly modified version of the URI class distributed with
* Http Client 3.1. The changes involve removing dependencies to other Http
* Client classes and the Commons Codec library. To this avail the following
@@ -138,8 +138,8 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* can be either in escaped or unescaped form.
*
* @param s URI character sequence
- * @param escaped <tt>true</tt> if URI character sequence is in escaped
- * form. <tt>false</tt> otherwise.
+ * @param escaped <code>true</code> if URI character sequence is in escaped
+ * form. <code>false</code> otherwise.
* @param charset the charset string to do escape encoding, if required
* @throws URIException If the URI cannot be created.
* @throws NullPointerException if input string is <code>null</code>
@@ -157,8 +157,8 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* can be either in escaped or unescaped form.
*
* @param s URI character sequence
- * @param escaped <tt>true</tt> if URI character sequence is in escaped
- * form. <tt>false</tt> otherwise.
+ * @param escaped <code>true</code> if URI character sequence is in escaped
+ * form. <code>false</code> otherwise.
* @throws URIException If the URI cannot be created.
* @throws NullPointerException if input string is <code>null</code>
* @see #getProtocolCharset
@@ -171,7 +171,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Construct a general URI from the given components.
- *
+ *
* <blockquote>
*
* <pre>
@@ -181,7 +181,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
* It's for absolute URI = <scheme>:<scheme-specific-part>#
* <fragment>.
*
@@ -214,7 +214,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Construct a general URI from the given components.
- *
+ *
* <blockquote>
*
* <pre>
@@ -225,7 +225,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
* It's for absolute URI = <scheme>:<path>?<query>#<
* fragment> and relative URI = <path>?<query>#<fragment
* >.
@@ -363,8 +363,8 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
*
* @param base the base URI
* @param relative the relative URI string
- * @param escaped <tt>true</tt> if URI character sequence is in escaped
- * form. <tt>false</tt> otherwise.
+ * @param escaped <code>true</code> if URI character sequence is in escaped
+ * form. <code>false</code> otherwise.
* @throws URIException If the new URI cannot be created.
* @since 3.0
*/
@@ -374,7 +374,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Construct a general URI with the given relative URI.
- *
+ *
* <blockquote>
*
* <pre>
@@ -383,11 +383,11 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
* Resolving Relative References to Absolute Form. <strong>Examples of
* Resolving Relative URI References</strong> Within an object with a
* well-defined base URI of
- *
+ *
* <blockquote>
*
* <pre>
@@ -395,9 +395,9 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
* the relative URI would be resolved as follows: Normal Examples
- *
+ *
* <blockquote>
*
* <pre>
@@ -426,9 +426,9 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
* Some URI schemes do not allow a hierarchical syntax matching the
- * <hier_part> syntax, and thus cannot use relative references.
+ * <hier_part> syntax, and thus cannot use relative references.
*
* @param base the base URI
* @param relative the relative URI
@@ -646,7 +646,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for digit.
- *
+ *
* <blockquote>
*
* <pre>
@@ -654,7 +654,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet digit = new BitSet(256);
// Static initializer for digit
@@ -666,7 +666,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for alpha.
- *
+ *
* <blockquote>
*
* <pre>
@@ -674,7 +674,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet alpha = new BitSet(256);
// Static initializer for alpha
@@ -689,7 +689,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for alphanum (join of alpha & digit).
- *
+ *
* <blockquote>
*
* <pre>
@@ -697,7 +697,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet alphanum = new BitSet(256);
// Static initializer for alphanum
@@ -708,7 +708,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for hex.
- *
+ *
* <blockquote>
*
* <pre>
@@ -717,7 +717,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet hex = new BitSet(256);
// Static initializer for hex
@@ -733,7 +733,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for escaped.
- *
+ *
* <blockquote>
*
* <pre>
@@ -741,7 +741,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet escaped = new BitSet(256);
// Static initializer for escaped
@@ -752,7 +752,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for mark.
- *
+ *
* <blockquote>
*
* <pre>
@@ -760,7 +760,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet mark = new BitSet(256);
// Static initializer for mark
@@ -779,7 +779,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Data characters that are allowed in a URI but do not have a reserved
* purpose are called unreserved.
- *
+ *
* <blockquote>
*
* <pre>
@@ -787,7 +787,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet unreserved = new BitSet(256);
// Static initializer for unreserved
@@ -798,7 +798,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for reserved.
- *
+ *
* <blockquote>
*
* <pre>
@@ -806,7 +806,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet reserved = new BitSet(256);
// Static initializer for reserved
@@ -825,7 +825,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for uric.
- *
+ *
* <blockquote>
*
* <pre>
@@ -833,7 +833,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet uric = new BitSet(256);
// Static initializer for uric
@@ -845,7 +845,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for fragment (alias for uric).
- *
+ *
* <blockquote>
*
* <pre>
@@ -853,13 +853,13 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet fragment = uric;
/**
* BitSet for query (alias for uric).
- *
+ *
* <blockquote>
*
* <pre>
@@ -867,13 +867,13 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet query = uric;
/**
* BitSet for pchar.
- *
+ *
* <blockquote>
*
* <pre>
@@ -881,7 +881,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet pchar = new BitSet(256);
// Static initializer for pchar
@@ -899,7 +899,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for param (alias for pchar).
- *
+ *
* <blockquote>
*
* <pre>
@@ -907,13 +907,13 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet param = pchar;
/**
* BitSet for segment.
- *
+ *
* <blockquote>
*
* <pre>
@@ -921,7 +921,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet segment = new BitSet(256);
// Static initializer for segment
@@ -933,7 +933,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for path segments.
- *
+ *
* <blockquote>
*
* <pre>
@@ -941,7 +941,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet path_segments = new BitSet(256);
// Static initializer for path_segments
@@ -952,7 +952,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* URI absolute path.
- *
+ *
* <blockquote>
*
* <pre>
@@ -960,7 +960,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet abs_path = new BitSet(256);
// Static initializer for abs_path
@@ -971,7 +971,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* URI bitset for encoding typical non-slash characters.
- *
+ *
* <blockquote>
*
* <pre>
@@ -980,7 +980,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet uric_no_slash = new BitSet(256);
// Static initializer for uric_no_slash
@@ -1000,7 +1000,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* URI bitset that combines uric_no_slash and uric.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1008,7 +1008,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet opaque_part = new BitSet(256);
// Static initializer for opaque_part
@@ -1020,7 +1020,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* URI bitset that combines absolute path and opaque part.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1028,7 +1028,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet path = new BitSet(256);
// Static initializer for path
@@ -1044,7 +1044,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Bitset that combines digit and dot fo IPv$address.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1052,7 +1052,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet IPv4address = new BitSet(256);
// Static initializer for IPv4address
@@ -1063,7 +1063,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* RFC 2373.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1071,7 +1071,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet IPv6address = new BitSet(256);
// Static initializer for IPv6address reference
@@ -1083,7 +1083,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* RFC 2732, 2373.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1091,7 +1091,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet IPv6reference = new BitSet(256);
// Static initializer for IPv6reference
@@ -1103,7 +1103,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for toplabel.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1111,7 +1111,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet toplabel = new BitSet(256);
// Static initializer for toplabel
@@ -1122,7 +1122,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for domainlabel.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1130,13 +1130,13 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet domainlabel = toplabel;
/**
* BitSet for hostname.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1144,7 +1144,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet hostname = new BitSet(256);
// Static initializer for hostname
@@ -1156,7 +1156,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for host.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1164,7 +1164,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet host = new BitSet(256);
// Static initializer for host
@@ -1176,7 +1176,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for hostport.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1184,7 +1184,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet hostport = new BitSet(256);
// Static initializer for hostport
@@ -1196,7 +1196,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Bitset for userinfo.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1205,7 +1205,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet userinfo = new BitSet(256);
// Static initializer for userinfo
@@ -1237,7 +1237,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Bitset for server.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1245,7 +1245,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet server = new BitSet(256);
// Static initializer for server
@@ -1257,7 +1257,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for reg_name.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1265,7 +1265,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet reg_name = new BitSet(256);
// Static initializer for reg_name
@@ -1284,7 +1284,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for authority.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1292,7 +1292,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet authority = new BitSet(256);
// Static initializer for authority
@@ -1303,7 +1303,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for scheme.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1311,7 +1311,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet scheme = new BitSet(256);
// Static initializer for scheme
@@ -1325,7 +1325,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for rel_segment.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1333,7 +1333,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet rel_segment = new BitSet(256);
// Static initializer for rel_segment
@@ -1351,7 +1351,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for rel_path.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1359,7 +1359,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet rel_path = new BitSet(256);
// Static initializer for rel_path
@@ -1370,7 +1370,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for net_path.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1378,7 +1378,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet net_path = new BitSet(256);
// Static initializer for net_path
@@ -1390,7 +1390,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for hier_part.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1398,7 +1398,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet hier_part = new BitSet(256);
// Static initializer for hier_part
@@ -1411,7 +1411,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for relativeURI.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1419,7 +1419,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet relativeURI = new BitSet(256);
// Static initializer for relativeURI
@@ -1433,7 +1433,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for absoluteURI.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1441,7 +1441,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet absoluteURI = new BitSet(256);
// Static initializer for absoluteURI
@@ -1454,7 +1454,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* BitSet for URI-reference.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1462,7 +1462,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*/
protected static final BitSet URI_reference = new BitSet(256);
// Static initializer for URI_reference
@@ -1742,30 +1742,30 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Encodes URI string. This is a two mapping, one from original characters
* to octets, and subsequently a second from octets to URI characters:
- *
+ *
* <blockquote>
*
* <pre>
- * original character sequence->octet sequence->URI character sequence
+ * original character sequence->octet sequence->URI character
sequence
* </pre>
*
* </blockquote>
- *
+ *
* An escaped octet is encoded as a character triplet, consisting of the
* percent character "%" followed by the two hexadecimal digits
representing
* the octet code. For example, "%20" is the escaped encoding for the
* US-ASCII space character.
- *
+ *
* Conversion from the local filesystem character set to UTF-8 will
normally
* involve a two step process. First convert the local character set to the
* UCS; then convert the UCS to UTF-8. The first step in the process can be
* performed by maintaining a mapping table that includes the local
* character set code and the corresponding UCS code. The next step is to
* convert the UCS character code to the UTF-8 encoding.
- *
+ *
* Mapping between vendor codepages can be done in a very similar manner as
* described above.
- *
+ *
* The only time escape encodings can allowedly be made is when a URI is
* being created from its component parts. The escape and validate methods
* are internally performed within this method.
@@ -1794,27 +1794,27 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* Decodes URI encoded string. This is a two mapping, one from URI
* characters to octets, and subsequently a second from octets to original
* characters:
- *
+ *
* <blockquote>
*
* <pre>
- * URI character sequence->octet sequence->original character sequence
+ * URI character sequence->octet sequence->original character
sequence
* </pre>
*
* </blockquote>
- *
+ *
* A URI must be separated into its components before the escaped
characters
* within those components can be allowedly decoded.
- *
+ *
* Notice that there is a chance that URI characters that are non UTF-8 may
* be parsed as valid UTF-8. A recent non-scientific analysis found that
EUC
* encoded Japanese words had a 2.7% false reading; SJIS had a 0.0005%
false
* reading; other encoding such as ASCII or KOI-8 have a 0% false reading.
- *
+ *
* The percent "%" character always has the reserved purpose of being the
* escape indicator, it must be escaped as "%25" in order to be used as
data
* within a URI.
- *
+ *
* The unescape method is internally performed within this method.
*
* @param component the URI character sequence
@@ -1836,27 +1836,27 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* Decodes URI encoded string. This is a two mapping, one from URI
* characters to octets, and subsequently a second from octets to original
* characters:
- *
+ *
* <blockquote>
*
* <pre>
- * URI character sequence->octet sequence->original character sequence
+ * URI character sequence->octet sequence->original character
sequence
* </pre>
*
* </blockquote>
- *
+ *
* A URI must be separated into its components before the escaped
characters
* within those components can be allowedly decoded.
- *
+ *
* Notice that there is a chance that URI characters that are non UTF-8 may
* be parsed as valid UTF-8. A recent non-scientific analysis found that
EUC
* encoded Japanese words had a 2.7% false reading; SJIS had a 0.0005%
false
* reading; other encoding such as ASCII or KOI-8 have a 0% false reading.
- *
+ *
* The percent "%" character always has the reserved purpose of being the
* escape indicator, it must be escaped as "%25" in order to be used as
data
* within a URI.
- *
+ *
* The unescape method is internally performed within this method.
*
* @param component the URI character sequence
@@ -1916,7 +1916,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* Validate the URI characters within a specific component. The component
* must be performed after escape encoding. Or it doesn't include escaped
* characters.
- *
+ *
* It's not that much strict, generous. The strict validation might be
* performed before being called this method.
*
@@ -1945,10 +1945,10 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* In order to avoid any possilbity of conflict with non-ASCII characters,
* Parse a URI reference as a <code>String</code> with the character
* encoding of the local system or the document.
- *
+ *
* The following line is the regular expression for breaking-down a URI
* reference into its components.
- *
+ *
* <blockquote>
*
* <pre>
@@ -1957,11 +1957,11 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
* For example, matching the above expression to
* http://jakarta.apache.org/ietf/uri/#Related results in the following
* subexpression matches:
- *
+ *
* <blockquote>
*
* <pre>
@@ -1970,14 +1970,14 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* $3 = //jakarta.apache.org
* authority = $4 = jakarta.apache.org
* path = $5 = /ietf/uri/
- * $6 = <undefined>
- * query = $7 = <undefined>
+ * $6 = <undefined>
+ * query = $7 = <undefined>
* $8 = #Related
* fragment = $9 = Related
* </pre>
*
* </blockquote>
- *
+ *
*
* @param original the original character sequence
* @param escaped <code>true</code> if <code>original</code> is escaped
@@ -2578,7 +2578,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Set the default charset of the protocol.
- *
+ *
* The character set used to store files SHALL remain a local decision and
* MAY depend on the capability of local operating systems. Prior to the
* exchange of URIs they SHOULD be converted into a ISO/IEC 10646 format
and
@@ -2586,13 +2586,13 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* URIs, will still allow backward compatibility with older systems because
* the code set positions for ASCII characters are identical to the one
byte
* sequence in UTF-8.
- *
+ *
* An individual URI scheme may require a single charset, define a default
* charset, or provide a way to indicate the charset used.
- *
+ *
* Always all the time, the setter method is always succeeded and throws
* <code>DefaultCharsetChanged</code> exception. So API programmer must
- * follow the following way: <code><pre>
+ * follow the following way: <pre>
* import org.apache.util.URI$DefaultCharsetChanged;
* .
* .
@@ -2607,7 +2607,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* // CASE 2: let user know the default document charset changed
* }
* }
- * </pre></code> The API programmer is responsible to set the correct
+ * </pre> The API programmer is responsible to set the correct
* charset. And each application should remember its own charset to
support.
*
* @param charset the default charset for each protocol
@@ -2623,10 +2623,10 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Get the default charset of the protocol.
- *
+ *
* An individual URI scheme may require a single charset, define a default
* charset, or provide a way to indicate the charset used.
- *
+ *
* To work globally either requires support of a number of character sets
* and to be able to convert between them, or the use of a single preferred
* character set. For support of global compatibility it is STRONGLY
@@ -2655,16 +2655,16 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Set the default charset of the document.
- *
+ *
* Notice that it will be possible to contain mixed characters (e.g.
* ftp://host/KoreanNamespace/ChineseResource). To handle the
Bi-directional
* display of these character sets, the protocol charset could be simply
* used again. Because it's not yet implemented that the insertion of BIDI
* control characters at different points during composition is extracted.
- *
+ *
* Always all the time, the setter method is always succeeded and throws
* <code>DefaultCharsetChanged</code> exception. So API programmer must
- * follow the following way: <code><pre>
+ * follow the following way: <pre>
* import org.apache.util.URI$DefaultCharsetChanged;
* .
* .
@@ -2679,7 +2679,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* // CASE 2: let user know the default protocol charset changed
* }
* }
- * </pre></code> The API programmer is responsible to set the correct
+ * </pre> The API programmer is responsible to set the correct
* charset. And each application should remember its own charset to
support.
*
* @param charset the default charset for the document
@@ -2745,7 +2745,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Set the authority. It can be one type of server, hostport, hostname,
* IPv4address, IPv6reference and reg_name.
- *
+ *
* <blockquote>
*
* <pre>
@@ -2753,7 +2753,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*
* @param escapedAuthority the raw escaped authority
* @throws URIException If {@link
#parseAuthority(java.lang.String,boolean)}
@@ -2850,7 +2850,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Get the host.
- *
+ *
* <blockquote>
*
* <pre>
@@ -2858,7 +2858,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*
* @return the host
* @see #getAuthority
@@ -2869,7 +2869,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Get the host.
- *
+ *
* <blockquote>
*
* <pre>
@@ -2877,7 +2877,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*
* @return the host
* @throws URIException If {@link #decode} fails
@@ -3149,7 +3149,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Get the raw-escaped path.
- *
+ *
* <blockquote>
*
* <pre>
@@ -3157,7 +3157,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*
* @return the raw-escaped path
*/
@@ -3167,7 +3167,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Get the escaped path.
- *
+ *
* <blockquote>
*
* <pre>
@@ -3177,7 +3177,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*
* @return the escaped path string
*/
@@ -3188,7 +3188,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Get the path.
- *
+ *
* <blockquote>
*
* <pre>
@@ -3196,7 +3196,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* </pre>
*
* </blockquote>
- *
+ *
*
* @return the path string
* @throws URIException If {@link #decode} fails.
@@ -3342,11 +3342,11 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Set the query.
- *
+ *
* When a query string is not misunderstood the reserved special characters
* ("&", "=", "+", ",", and "$") within a query component, it is
* recommended to use in encoding the whole query with this method.
- *
+ *
* The additional APIs for the special purpose using by the reserved
special
* characters used in each protocol are implemented in each protocol
classes
* inherited from <code>URI</code>. So refer to the same-named APIs
@@ -3451,13 +3451,13 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Get the raw-escaped fragment.
- *
+ *
* The optional fragment identifier is not part of a URI, but is often used
* in conjunction with a URI.
- *
+ *
* The format and interpretation of fragment identifiers is dependent on
the
* media type [RFC2046] of the retrieval result.
- *
+ *
* A fragment identifier is only meaningful when a URI reference is
intended
* for retrieval and the result of that retrieval is a document for which
* the identified fragment is consistently defined.
@@ -3511,7 +3511,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Normalize the given hier path part.
- *
+ *
* Algorithm taken from URI reference parser at
* http://www.apache.org/~fielding/uri/rev-2002/issues.html.
*
@@ -3644,6 +3644,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* @param obj an object to compare
* @return true if two URI objects are equal
*/
+ @Override
public boolean equals(Object obj) {
// normalize and test each components
@@ -3716,6 +3717,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
*
* @return a has code value for this URI
*/
+ @Override
public int hashCode() {
if (hash == 0) {
char[] c = _uri;
@@ -3758,12 +3760,13 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* Create and return a copy of this object, the URI-reference containing
the
* userinfo component. Notice that the whole URI-reference including the
* userinfo component counld not be gotten as a <code>String</code>.
- *
+ *
* To copy the identical <code>URI</code> object including the userinfo
* component, it should be used.
*
* @return a clone of this instance
*/
+ @Override
public synchronized Object clone() throws CloneNotSupportedException {
URI instance = (URI) super.clone();
@@ -3800,12 +3803,12 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* It can be gotten the URI character sequence. It's raw-escaped. For the
* purpose of the protocol to be transported, it will be useful.
- *
+ *
* It is clearly unwise to use a URL that contains a password which is
* intended to be secret. In particular, the use of a password within the
* 'userinfo' component of a URL is strongly disrecommended except in those
* rare cases where the 'password' parameter is intended to be public.
- *
+ *
* When you want to get each part of the userinfo, you need to use the
* specific methods in the specific URL. It depends on the specific URL.
*
@@ -3878,11 +3881,11 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* Get the escaped URI string.
- *
+ *
* On the document, the URI-reference form is only used without the
userinfo
* component like http://jakarta.apache.org/ by the security reason. But
the
* URI-reference form with the userinfo component could be parsed.
- *
+ *
* In other words, this URI and any its subclasses must not expose the
* URI-reference expression with the userinfo component like
* http://user:password@hostport/restricted_zone.<br>
@@ -3893,6 +3896,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
* @return the escaped URI string
* @see #clone()
*/
+ @Override
public String toString() {
return getEscapedURI();
}
@@ -3964,7 +3968,7 @@ public class URI implements Cloneable, Comparable<URI>,
Serializable {
/**
* A mapping to determine the (somewhat arbitrarily) preferred charset for
a
* given locale. Supports all locales recognized in JDK 1.1.
- *
+ *
* The distribution of this class is Servlets.com. It was originally
written
* by Jason Hunter [jhunter at acm.org] and used by with permission.
*/
diff --git
a/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntriesHandler.java
b/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntriesHandler.java
index ae754c0..a32a457 100644
---
a/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntriesHandler.java
+++
b/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntriesHandler.java
@@ -24,20 +24,18 @@ import java.util.Iterator;
import java.util.List;
import java.util.Map;
-import org.apache.sling.api.resource.ResourceResolver;
-import org.apache.sling.api.resource.mapping.ResourceMapper;
import org.jetbrains.annotations.NotNull;
/**
* Exposes low-level methods used for resource resolving and mapping
- *
+ *
* <p>This interface is intended for bundle internal use and its main goal is
to
- * prevent accidental modifications of the internal state by only exposing
+ * prevent accidental modifications of the internal state by only exposing
* accessor methods.</p>
- *
- * @see ResourceMapper
- * @see ResourceResolver#map(String)
- * @see ResourceResolver#map(javax.servlet.http.HttpServletRequest, String)
+ *
+ * @see org.apache.sling.api.resource.mapping.ResourceMapper
+ * @see org.apache.sling.api.resource.ResourceResolver#map(String)
+ * @see
org.apache.sling.api.resource.ResourceResolver#map(javax.servlet.http.HttpServletRequest,
String)
*/
public interface MapEntriesHandler {
@@ -62,7 +60,7 @@ public interface MapEntriesHandler {
public Map<String, String> getAliasMap(String parentPath) {
return Collections.emptyMap();
}
-
+
@Override
public Map<String, List<String>> getVanityPathMappings() {
return Collections.emptyMap();
@@ -72,7 +70,7 @@ public interface MapEntriesHandler {
public boolean isOptimizeAliasResolutionEnabled() {
return false;
}
-
+
@Override
public void logDisableAliasOptimization() {
// nothing to do
@@ -84,17 +82,17 @@ public interface MapEntriesHandler {
* If it is enabled {@link #getAliasMap(String)} can be used.
*/
boolean isOptimizeAliasResolutionEnabled();
-
+
/**
* Log an error if alias optimization should be used but is currently
disabled
*/
void logDisableAliasOptimization();
/**
- * Returns all alias entries that for children of the specified
<tt>parentPath</tt>
- *
+ * Returns all alias entries that for children of the specified
<code>parentPath</code>
+ *
* <p>The returned map has resource names as keys and aliases as
values.</p>
- *
+ *
* @param parentPath the parent path
* @return a map of all child alias entries, possibly empty
*/
@@ -102,42 +100,42 @@ public interface MapEntriesHandler {
/**
* Creates an iterator over the possibly applicable mapping entries for
resolving a resource
- *
+ *
* <p>This method uses the request path to filter out any unapplicable
mapping entries and
* is therefore preferrable over {@link #getResolveMaps()}.</p>
- *
- * <p>The iterator will iterate over the mapping entries in the order of
the pattern length.</p>
- *
+ *
+ * <p>The iterator will iterate over the mapping entries in the order of
the pattern length.</p>
+ *
* @return the map entry iterator
*/
@NotNull Iterator<MapEntry> getResolveMapsIterator(@NotNull String
requestPath);
/**
* Return a flat listing of map entries used for mapping resources to URLs
- *
+ *
* <p>This method returns information about all mapping rules. Note that
vanity paths are excluded.</p>
- *
+ *
* @return an unmodifiable collection of map entries
*/
@NotNull Collection<MapEntry> getMapMaps();
/**
* Creates a flat listing of all the map entries used for resolving URLs
to resources
- *
+ *
* <p>This method returns information about all resolve rules, such as
vanity paths, mapping entries,
* virtual URLs and URL mappings.</p>
- *
+ *
* <p>This list is computed on-demand and therefore should not be used in
performance-critical code.</p>
- *
+ *
* @return an unmodifiable, sorted, list of resolution map entries
*/
@NotNull List<MapEntry> getResolveMaps();
-
+
/**
* Returns vanity paths mappings
- *
+ *
* <p>The keys in the map are resource paths and the values are the vanity
mappings.</p>
- *
+ *
* @return an unmodifiable list of vanity path mappings
*/
@NotNull Map<String, List<String>> getVanityPathMappings();
