jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r785711 - in /jackrabbit/trunk/jackrabbit-spi-commons/src: main/java/org/apache/jackrabbit/spi/commons/ main/java/org/apache/jackrabbit/spi/commons/conversion/ main/java/org/apache/jackrabbit/spi/commons/name/ main/java/org/apache/jackrabbi...
Date Wed, 17 Jun 2009 16:38:51 GMT
Author: angela
Date: Wed Jun 17 16:38:50 2009
New Revision: 785711

URL: http://svn.apache.org/viewvc?rev=785711&view=rev
Log:
JCR-2156: Usage of "qualified name" in JavaDoc and Comments


Modified:
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeDefinitionImpl.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeTypeDefinitionImpl.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QPropertyDefinitionImpl.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingNameResolver.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingPathResolver.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameParser.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameResolver.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingNameResolver.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingPathResolver.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/PathParser.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/NameFactoryImpl.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/PathFactoryImpl.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/ItemDefinitionImpl.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/CompactNodeTypeDefReader.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/QNodeTypeDefinitionsBuilder.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/query/qom/AbstractQOMNode.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/value/ValueFormat.java
    jackrabbit/trunk/jackrabbit-spi-commons/src/test/java/org/apache/jackrabbit/spi/commons/value/QValueTest.java

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeDefinitionImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeDefinitionImpl.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeDefinitionImpl.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeDefinitionImpl.java
Wed Jun 17 16:38:50 2009
@@ -57,7 +57,7 @@
     }
 
     /**
-     * Creates a new qualified node definition based on a JCR NodeDefinition.
+     * Creates a new SPI node definition based on a JCR NodeDefinition.
      *
      * @param name              the name of the child item.
      * @param declaringNodeType the delaring node type

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeTypeDefinitionImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeTypeDefinitionImpl.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeTypeDefinitionImpl.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QNodeTypeDefinitionImpl.java
Wed Jun 17 16:38:50 2009
@@ -40,7 +40,7 @@
 import java.io.Serializable;
 
 /**
- * <code>QNodeTypeDefinitionImpl</code> implements a serializable qualified node
+ * <code>QNodeTypeDefinitionImpl</code> implements a serializable SPI node
  * type definition.
  */
 public class QNodeTypeDefinitionImpl implements QNodeTypeDefinition, Serializable {
@@ -104,7 +104,7 @@
     /**
      * Copy constructor.
      *
-     * @param nt the qualified node type definition.
+     * @param nt the node type definition.
      */
     public QNodeTypeDefinitionImpl(QNodeTypeDefinition nt) {
         this(nt.getName(), nt.getSupertypes(), nt.getSupportedMixinTypes(),
@@ -114,7 +114,7 @@
     }
 
     /**
-     * Creates a new serializable qualified node type definition.
+     * Creates a new serializable SPI node type definition.
      *
      * @param name                   the name of the node type
      * @param supertypes             the names of the supertypes
@@ -141,7 +141,7 @@
     }
 
     /**
-     * Creates a new serializable qualified node type definition. Same as
+     * Creates a new serializable SPI node type definition. Same as
      * {@link #QNodeTypeDefinitionImpl(Name, Name[], Name[], boolean, boolean, boolean, boolean,
Name, QPropertyDefinition[], QNodeDefinition[])}
      * but using <code>false</code> for both {@link #isAbstract()} and {@link
#isQueryable)}.
      *
@@ -172,7 +172,7 @@
     }
 
     /**
-     * Creates a new serializable qualified node type definition.
+     * Creates a new serializable SPI node type definition.
      *
      * @param name                   the name of the node type
      * @param supertypes             the names of the supertypes
@@ -363,7 +363,7 @@
      * Returns an array of serializable property definitions for
      * <code>propDefs</code>.
      *
-     * @param propDefs the qualified property definitions.
+     * @param propDefs the SPI property definitions.
      * @return an array of serializable property definitions.
      */
     private static QPropertyDefinition[] getSerializablePropertyDefs(
@@ -383,7 +383,7 @@
      * Returns an array of serializable node definitions for
      * <code>nodeDefs</code>.
      *
-     * @param nodeDefs the qualified node definitions.
+     * @param nodeDefs the node definitions.
      * @return an array of serializable node definitions.
      */
     private static QNodeDefinition[] getSerializableNodeDefs(

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QPropertyDefinitionImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QPropertyDefinitionImpl.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QPropertyDefinitionImpl.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/QPropertyDefinitionImpl.java
Wed Jun 17 16:38:50 2009
@@ -25,8 +25,8 @@
 import java.util.Set;
 
 /**
- * <code>QPropertyDefinitionImpl</code> implements a qualified property
- * definition.
+ * <code>QPropertyDefinitionImpl</code> implements SPI property
+ * definition interface.
  */
 public class QPropertyDefinitionImpl
         extends QItemDefinitionImpl
@@ -84,7 +84,7 @@
     }
 
     /**
-     * Creates a new serializable qualified property definition.
+     * Creates a new serializable property definition.
      *
      * @param name              the name of the child item.
      * @param declaringNodeType the delaring node type
@@ -115,7 +115,7 @@
     }
 
     /**
-     * Creates a new serializable qualified property definition.
+     * Creates a new serializable property definition.
      *
      * @param name              the name of the child item.
      * @param declaringNodeType the delaring node type

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingNameResolver.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingNameResolver.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingNameResolver.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingNameResolver.java
Wed Jun 17 16:38:50 2009
@@ -60,41 +60,41 @@
 
     //-------------------------------------------------------< NameResolver >---
     /**
-     * Returns the qualified name for the given prefixed JCR name. The name
+     * Returns a <code>Name</code> for the given prefixed JCR name. The name
      * is first looked up form the generational cache and the call gets
      * delegated to the decorated name resolver only if the cache misses.
      *
-     * @param name prefixed JCR name
-     * @return qualified name
+     * @param jcrName A JCR name String.
+     * @return A <code>Name</code> object.
      * @throws IllegalNameException if the JCR name format is invalid
      * @throws NamespaceException if the namespace prefix can not be resolved
      */
-    public Name getQName(String name)
+    public Name getQName(String jcrName)
             throws IllegalNameException, NamespaceException {
-        Name qname = (Name) cache.get(name);
-        if (qname == null) {
-            qname = resolver.getQName(name);
-            cache.put(name, qname);
+        Name name = (Name) cache.get(jcrName);
+        if (name == null) {
+            name = resolver.getQName(jcrName);
+            cache.put(jcrName, name);
         }
-        return qname;
+        return name;
     }
 
 
     /**
-     * Returns the prefixed JCR name for the given qualified name. The name
+     * Returns the prefixed JCR name for the given <code>Name</code>. The name
      * is first looked up form the generational cache and the call gets
      * delegated to the decorated name resolver only if the cache misses.
      *
-     * @param qname qualified name
-     * @return prefixed JCR name
+     * @param name The name object.
+     * @return qualified JCR name in the form <code>prefix:localName</code>.
      * @throws NamespaceException if the namespace URI can not be resolved
      */
-    public String getJCRName(Name qname) throws NamespaceException {
-        String name = (String) cache.get(qname);
-        if (name == null) {
-            name = resolver.getJCRName(qname);
-            cache.put(qname, name);
+    public String getJCRName(Name name) throws NamespaceException {
+        String jcrName = (String) cache.get(name);
+        if (jcrName == null) {
+            jcrName = resolver.getJCRName(name);
+            cache.put(name, jcrName);
         }
-        return name;
+        return jcrName;
     }
 }

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingPathResolver.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingPathResolver.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingPathResolver.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/CachingPathResolver.java
Wed Jun 17 16:38:50 2009
@@ -61,15 +61,17 @@
     //--------------------------------------------------------< PathResolver >
 
     /**
-     * Returns the qualified path for the given prefixed JCR path. The path
-     * is first looked up form the generational cache and the call gets
+     * Returns the <code>Path</code> object for the given JCR path String.
+     * The path is first looked up form the generational cache and the call gets
      * delegated to the decorated path resolver only if the cache misses.
      *
-     * @param path prefixed JCR path
-     * @return qualified path
+     * @param path A JCR path String.
+     * @return A <code>Path</code> object.
      * @throws MalformedPathException if the JCR path format is invalid
-     * @throws IllegalNameException if any of the JCR names contained in the path are invalid.
-     * @throws NamespaceException if a namespace prefix can not be resolved
+     * @throws IllegalNameException if any of the JCR names contained in the
+     * path are invalid.
+     * @throws NamespaceException if a namespace prefix can not be resolved.
+     * @see PathResolver#getQPath(String) 
      */
     public Path getQPath(String path) throws MalformedPathException, IllegalNameException,
NamespaceException {
         return getQPath(path, true);
@@ -103,21 +105,21 @@
 
 
     /**
-     * Returns the prefixed JCR path for the given qualified path. The path
+     * Returns the JCR path String for the given <code>Path</code>. The path
      * is first looked up form the generational cache and the call gets
      * delegated to the decorated path resolver only if the cache misses.
      *
-     * @param qpath qualified path
-     * @return prefixed JCR path
-     * @throws NamespaceException if a namespace URI can not be resolved
+     * @param path A <code>Path</code> object.
+     * @return A JCR path String in the standard form.
+     * @throws NamespaceException if a namespace URI can not be resolved.
+     * @see PathResolver#getJCRPath(org.apache.jackrabbit.spi.Path)
      */
-    public String getJCRPath(Path qpath) throws NamespaceException {
-        String path = (String) cache.get(qpath);
-        if (path == null) {
-            path = resolver.getJCRPath(qpath);
-            cache.put(qpath, path);
+    public String getJCRPath(Path path) throws NamespaceException {
+        String jcrPath = (String) cache.get(path);
+        if (jcrPath == null) {
+            jcrPath = resolver.getJCRPath(path);
+            cache.put(path, jcrPath);
         }
-        return path;
+        return jcrPath;
     }
-
 }

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameParser.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameParser.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameParser.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameParser.java
Wed Jun 17 16:38:50 2009
@@ -41,7 +41,7 @@
      * Parses the <code>jcrName</code> (either qualified or expanded) and
      * returns a new <code>Name</code>.
      *
-     * @param jcrName the name to be parsed. The jcrName may either in the
+     * @param jcrName the name to be parsed. The jcrName may either be in the
      * qualified or in the expanded form.
      * @param resolver <code>NamespaceResolver</code> use to retrieve the
      * namespace URI from the prefix contained in the given JCR name.

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameResolver.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameResolver.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameResolver.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/NameResolver.java
Wed Jun 17 16:38:50 2009
@@ -21,26 +21,27 @@
 import javax.jcr.NamespaceException;
 
 /**
- * Resolver for prefixed JCR names and namespace-qualified
- * {@link Name Names}.
+ * Resolver for JCR name Strings and {@link Name} objects.
  */
 public interface NameResolver {
 
     /**
-     * Returns the qualified name for the given prefixed JCR name.
+     * Returns the <code>Name</code> for the given JCR name String.
      *
-     * @param name prefixed JCR name
-     * @return qualified name
+     * @param name A JCR name String.
+     * @return A <code>Name</code> object.
      * @throws IllegalNameException if the JCR name format is invalid
      * @throws NamespaceException if the namespace prefix can not be resolved
      */
     Name getQName(String name) throws IllegalNameException, NamespaceException;
 
     /**
-     * Returns the prefixed JCR name for the given qualified name.
+     * Returns the qualified JCR name String for the given <code>Name</code>
object.
      *
-     * @param name qualified name
-     * @return prefixed JCR name
+     * @param name A <code>Name</code> object.
+     * @return The qualified JCR name String consisting of
+     * <code>prefix:localName</code> or
+     * <code>localName</code> in case of the empty namespace.
      * @throws NamespaceException if the namespace URI can not be resolved
      */
     String getJCRName(Name name) throws NamespaceException;

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingNameResolver.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingNameResolver.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingNameResolver.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingNameResolver.java
Wed Jun 17 16:38:50 2009
@@ -52,26 +52,28 @@
     //--------------------------------------------------------< NameResolver >
 
     /**
-     * Parses the prefixed JCR name and returns the resolved qualified name.
+     * Parses the given JCR name and returns the resolved <code>Name</code> object.
      *
-     * @param name prefixed JCR name
-     * @return qualified name
+     * @param jcrName A JCR name String
+     * @return A <code>Name</code> object.
      * @throws IllegalNameException if the JCR name format is invalid
-     * @throws NamespaceException if the namespace prefix can not be resolved
+     * @throws NamespaceException if the namespace prefix can not be resolved.
+     * @see NameResolver#getQName(String)
      */
-    public Name getQName(String name) throws IllegalNameException, NamespaceException {
-        return NameParser.parse(name, resolver, nameFactory);
+    public Name getQName(String jcrName) throws IllegalNameException, NamespaceException
{
+        return NameParser.parse(jcrName, resolver, nameFactory);
     }
 
     /**
-     * Returns the prefixed JCR name for the given qualified name.
+     * Returns the qualified JCR name for the given <code>Name</code> object.
      * If the name is in the default namespace, then the local name
      * is returned without a prefix. Otherwise the prefix for the
-     * namespace is resolved and used to construct returned the JCR name.
+     * namespace is resolved and used to construct the JCR name.
      *
-     * @param name qualified name
-     * @return prefixed JCR name
-     * @throws NamespaceException if the namespace URI can not be resolved
+     * @param name A <code>Name</code> object.
+     * @return A qualified JCR name string.
+     * @throws NamespaceException if the namespace URI can not be resolved.
+     * @see NameResolver#getJCRName(org.apache.jackrabbit.spi.Name)
      */
     public String getJCRName(Name name) throws NamespaceException {
         String uri = name.getNamespaceURI();

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingPathResolver.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingPathResolver.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingPathResolver.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/ParsingPathResolver.java
Wed Jun 17 16:38:50 2009
@@ -68,35 +68,36 @@
     }
 
     /**
-     * Parses the given JCR path and returns the resolved qualified path.
+     * Parses the given JCR path into a <code>Path</code> object.
      *
-     * @param path prefixed JCR path
-     * @return qualified path
+     * @param jcrPath A JCR path String.
+     * @return A <code>Path</code> object.
      * @throws MalformedPathException if the JCR path format is invalid.
      * @throws IllegalNameException if any of the JCR names contained in the path are invalid.
      * @throws NamespaceException if a namespace prefix can not be resolved
      */
-    public Path getQPath(String path) throws MalformedPathException, IllegalNameException,
NamespaceException {
-        return PathParser.parse(path, nameResolver, idResolver, pathFactory);
+    public Path getQPath(String jcrPath) throws MalformedPathException, IllegalNameException,
NamespaceException {
+        return PathParser.parse(jcrPath, nameResolver, idResolver, pathFactory);
     }
 
     /**
      * Calls {@link PathParser#parse(String, NameResolver, IdentifierResolver, org.apache.jackrabbit.spi.PathFactory)}
-     * from the given <code>path</code>.
+     * from the given <code>jcrPath</code>.
      * 
      * @see PathResolver#getQPath(String, boolean)
      */
-    public Path getQPath(String path, boolean normalizeIdentifier) throws MalformedPathException,
IllegalNameException, NamespaceException {
-        return PathParser.parse(path, nameResolver, idResolver, pathFactory, normalizeIdentifier);
+    public Path getQPath(String jcrPath, boolean normalizeIdentifier) throws MalformedPathException,
IllegalNameException, NamespaceException {
+        return PathParser.parse(jcrPath, nameResolver, idResolver, pathFactory, normalizeIdentifier);
     }
 
 
     /**
-     * Returns the given JCR path for the given qualified path.
+     * Returns the JCR path representation for the given <code>Path</code> object.
      *
-     * @param path qualified path
-     * @return prefixed JCR path
-     * @throws NamespaceException if a namespace URI can not be resolved
+     * @param path A <code>Path</code> object.
+     * @return A JCR path String in the standard form.
+     * @throws NamespaceException if a namespace URI can not be resolved.
+     * @see PathResolver#getJCRPath(org.apache.jackrabbit.spi.Path) 
      */
     public String getJCRPath(Path path) throws NamespaceException {
         StringBuffer buffer = new StringBuffer();

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/PathParser.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/PathParser.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/PathParser.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/conversion/PathParser.java
Wed Jun 17 16:38:50 2009
@@ -44,14 +44,14 @@
     private static final int STATE_URI_END = 10;
 
     /**
-     * Parses <code>jcrPath</code> into a qualified path using
+     * Parses <code>jcrPath</code> into a <code>Path</code> object
using
      * <code>resolver</code> to convert prefixes into namespace URI's. If
      * resolver is <code>null</code> this method only checks the format of the
      * passed String and returns <code>null</code>.
      *
      * @param jcrPath the jcr path.
      * @param resolver the namespace resolver.
-     * @param factory
+     * @param factory <code>PathFactory</code> to be used.
      * @return A path object.
      * @throws MalformedPathException If the <code>jcrPath</code> is malformed.
      * @throws IllegalNameException if any of the jcrNames is malformed.
@@ -63,7 +63,7 @@
     }
 
     /**
-     * Parses <code>jcrPath</code> into a qualified path using
+     * Parses <code>jcrPath</code> into a <code>Path</code> object
using
      * <code>resolver</code> to convert prefixes into namespace URI's. If the
      * specified <code>jcrPath</code> is an identifier based absolute path
      * beginning with an identifier segment the specified
@@ -91,7 +91,7 @@
     }
 
     /**
-     * Parses <code>jcrPath</code> into a qualified path using
+     * Parses <code>jcrPath</code> into a <code>Path</code> object
using
      * <code>resolver</code> to convert prefixes into namespace URI's. If the
      * specified <code>jcrPath</code> is an identifier based absolute path
      * beginning with an identifier segment the specified

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/NameFactoryImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/NameFactoryImpl.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/NameFactoryImpl.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/NameFactoryImpl.java
Wed Jun 17 16:38:50 2009
@@ -29,7 +29,7 @@
     /**
      * Cache of flyweight name instances.
      *
-     * @see https://issues.apache.org/jira/browse/JCR-1663
+     * @see <a href="https://issues.apache.org/jira/browse/JCR-1663">JCR-1663</a>
      */
     private final HashCache cache = new HashCache();
 
@@ -84,16 +84,16 @@
      */
     private static class NameImpl implements Name {
 
-        /** The memorized hash code of this qualified name. */
+        /** The memorized hash code of this name. */
         private transient int hash;
 
-        /** The memorized string representation of this qualified name. */
+        /** The memorized string representation of this name. */
         private transient String string;
 
-        /** The internalized namespace URI of this qualified name. */
+        /** The internalized namespace URI of this name. */
         private final String namespaceURI;
 
-        /** The local part of this qualified name. */
+        /** The local part of this name. */
         private final String localName;
 
         private NameImpl(String namespaceURI, String localName) {
@@ -140,13 +140,13 @@
         }
 
         /**
-         * Compares two qualified names for equality. Returns <code>true</code>
-         * if the given object is a qualified name and has the same namespace URI
-         * and local part as this qualified name.
+         * Compares two names for equality. Returns <code>true</code>
+         * if the given object is a <code>Name</code> and has the same namespace
+         * URI and local part as this <code>Name</code>.
          *
-         * @param obj the object to compare this qualified name with
-         * @return <code>true</code> if the object is equal to this qualified
name,
-         *         <code>false</code> otherwise
+         * @param obj the object to compare.
+         * @return <code>true</code> if the object is equal to this <code>Name</code>,
+         *         <code>false</code> otherwise.
          * @see Object#equals(Object)
          */
         public boolean equals(Object obj) {
@@ -167,8 +167,8 @@
         }
 
         /**
-         * Returns the hash code of this qualified name. The hash code is
-         * computed from the namespace URI and local part of the qualified
+         * Returns the hash code of this name. The hash code is
+         * computed from the namespace URI and local part of the
          * name and memorized for better performance.
          *
          * @return hash code
@@ -188,7 +188,7 @@
 
         //------------------------------------------------------< Cloneable >---
         /**
-         * Creates a clone of this qualified name.
+         * Creates a clone of this <code>Name</code>.
          * Overriden in order to make <code>clone()</code> public.
          *
          * @return a clone of this instance
@@ -202,11 +202,11 @@
 
         //-----------------------------------------------------< Comparable >---
         /**
-         * Compares two qualified names.
+         * Compares two <code>Name</code>s.
          *
-         * @param o the object to compare this qualified name with
+         * @param o the object to compare.
          * @return comparison result
-         * @throws ClassCastException if the given object is not a qualified name
+         * @throws ClassCastException if the given object is not a <code>Name</code>.
          * @see Comparable#compareTo(Object)
          */
         public int compareTo(Object o) {

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/PathFactoryImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/PathFactoryImpl.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/PathFactoryImpl.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/name/PathFactoryImpl.java
Wed Jun 17 16:38:50 2009
@@ -722,7 +722,7 @@
     private static class Element implements Path.Element {
 
         /**
-         * Qualified name of the path element.
+         * Name of the path element.
          */
         private final Name name;
 
@@ -734,11 +734,11 @@
 
         /**
          * Private constructor for creating a path element with the given
-         * qualified name and index. Instead of using this constructor directly
+         * name and index. Instead of using this constructor directly
          * the factory methods {@link PathFactory#createElement(Name)} and
          * {@link PathFactory#create(Name, int)} should be used.
          *
-         * @param name  qualified name
+         * @param name A <code>Name</code> object.
          * @param index index
          */
         private Element(Name name, int index) {

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/ItemDefinitionImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/ItemDefinitionImpl.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/ItemDefinitionImpl.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/ItemDefinitionImpl.java
Wed Jun 17 16:38:50 2009
@@ -45,7 +45,7 @@
     protected static final String ANY_NAME = "*";
 
     /**
-     * The namespace resolver used to translate qualified names to JCR names.
+     * The namespace resolver used to translate <code>Name</code>s to JCR name
strings.
      */
     protected final NamePathResolver resolver;
 

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/CompactNodeTypeDefReader.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/CompactNodeTypeDefReader.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/CompactNodeTypeDefReader.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/CompactNodeTypeDefReader.java
Wed Jun 17 16:38:50 2009
@@ -643,11 +643,11 @@
     }
 
     /**
-     * Converts the given string into a qualified name using the current
+     * Converts the given string into a <code>Name</code> using the current
      * namespace mapping.
      *
      * @param stringName
-     * @return the qualified name
+     * @return A <code>Name</code> object.
      * @throws ParseException if the conversion fails
      */
     private Name toName(String stringName) throws ParseException {

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/QNodeTypeDefinitionsBuilder.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/QNodeTypeDefinitionsBuilder.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/QNodeTypeDefinitionsBuilder.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/nodetype/compact/QNodeTypeDefinitionsBuilder.java
Wed Jun 17 16:38:50 2009
@@ -356,10 +356,10 @@
          *
          * @param constraint
          * @param resolver
-         * @return A syntactically valid value constrained which refers to fully qualified
names and
-         *         paths only.
-         * @throws InvalidConstraintException if <code>constraint</code> cannot
be converted to a
-         *                 valid value constrained.
+         * @return A syntactically valid value constrained which refers to
+         * internal names and paths representations only.
+         * @throws InvalidConstraintException if <code>constraint</code> cannot
+         * be converted to a valid value constrained.
          */
         public abstract String createValueConstraint(String constraint, NamePathResolver
resolver)
                 throws InvalidConstraintException;

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/query/qom/AbstractQOMNode.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/query/qom/AbstractQOMNode.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/query/qom/AbstractQOMNode.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/query/qom/AbstractQOMNode.java
Wed Jun 17 16:38:50 2009
@@ -45,10 +45,10 @@
     //---------------------------< internal >-----------------------------------
 
     /**
-     * Returns the prefixed JCR name for the given qualified name or
+     * Returns the JCR name string for the given <code>Name</code> or
      * <code>null</code> if <code>name</code> is <code>null</code>.
      *
-     * @param name the qualified name.
+     * @param name the <code>Name</code>.
      * @return the prefixed JCR name or <code>name.toString()</code> if an
      *         unknown namespace URI is encountered.
      */
@@ -64,12 +64,12 @@
     }
 
     /**
-     * Returns the prefixed JCR path for the given qualified path or
+     * Returns the JCR path String for the given <code>Path</code> object or
      * <code>null</code> if <code>path</code> is <code>null</code>.
      *
-     * @param path qualified path
-     * @return prefixed JCR path or <code>path.toString()</code> if an unknown
-     *         namespace URI is encountered.
+     * @param path A <code>Path</code> object.
+     * @return JCR path in the standard form or <code>path.toString()</code>
+     * if an unknown namespace URI is encountered.
      */
     protected String getJCRPath(Path path) {
         if (path == null) {

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/value/ValueFormat.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/value/ValueFormat.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/value/ValueFormat.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/value/ValueFormat.java
Wed Jun 17 16:38:50 2009
@@ -136,52 +136,52 @@
     }
 
     /**
-     * @param qualifiedValue
+     * @param value
      * @param resolver
      * @param factory
-     * @return the JCR value created from the given <code>qualifiedValue</code>.
+     * @return the JCR value created from the given <code>QValue</code>.
      * @throws RepositoryException
      */
-    public static Value getJCRValue(QValue qualifiedValue,
+    public static Value getJCRValue(QValue value,
                                     NamePathResolver resolver,
                                     ValueFactory factory) throws RepositoryException {
         if (factory instanceof ValueFactoryQImpl) {
-            return ((ValueFactoryQImpl)factory).createValue(qualifiedValue);
+            return ((ValueFactoryQImpl)factory).createValue(value);
         } else {
             Value jcrValue;
-            int propertyType = qualifiedValue.getType();
+            int propertyType = value.getType();
             switch (propertyType) {
                 case PropertyType.STRING:
                 case PropertyType.REFERENCE:
                 case PropertyType.WEAKREFERENCE:
                 case PropertyType.URI:
-                    jcrValue = factory.createValue(qualifiedValue.getString(), propertyType);
+                    jcrValue = factory.createValue(value.getString(), propertyType);
                     break;
                 case PropertyType.PATH:
-                    Path qPath = qualifiedValue.getPath();
+                    Path qPath = value.getPath();
                     jcrValue = factory.createValue(resolver.getJCRPath(qPath), propertyType);
                     break;
                 case PropertyType.NAME:
-                    Name qName = qualifiedValue.getName();
+                    Name qName = value.getName();
                     jcrValue = factory.createValue(resolver.getJCRName(qName), propertyType);
                     break;
                 case PropertyType.BOOLEAN:
-                    jcrValue = factory.createValue(qualifiedValue.getBoolean());
+                    jcrValue = factory.createValue(value.getBoolean());
                     break;
                 case PropertyType.BINARY:
-                    jcrValue = factory.createValue(qualifiedValue.getBinary());
+                    jcrValue = factory.createValue(value.getBinary());
                     break;
                 case PropertyType.DATE:
-                    jcrValue = factory.createValue(qualifiedValue.getCalendar());
+                    jcrValue = factory.createValue(value.getCalendar());
                     break;
                 case PropertyType.DOUBLE:
-                    jcrValue = factory.createValue(qualifiedValue.getDouble());
+                    jcrValue = factory.createValue(value.getDouble());
                     break;
                 case PropertyType.LONG:
-                    jcrValue = factory.createValue(qualifiedValue.getLong());
+                    jcrValue = factory.createValue(value.getLong());
                     break;
                 case PropertyType.DECIMAL:
-                    jcrValue = factory.createValue(qualifiedValue.getDecimal());
+                    jcrValue = factory.createValue(value.getDecimal());
                     break;
                 default:
                     throw new RepositoryException("illegal internal value type");
@@ -196,15 +196,15 @@
      * {@link #getJCRValue(QValue, NamePathResolver, ValueFactory)} followed by
      * {@link Value#getString()}.
      *
-     * @param qualifiedValue
+     * @param value
      * @param resolver
-     * @return the JCR String representation for the given <code>qualifiedValue</code>.
+     * @return the JCR String representation for the given <code>QValue</code>.
      * @throws RepositoryException
      */
-    public static String getJCRString(QValue qualifiedValue,
+    public static String getJCRString(QValue value,
                                       NamePathResolver resolver) throws RepositoryException
{
         String jcrString;
-        int propertyType = qualifiedValue.getType();
+        int propertyType = value.getType();
         switch (propertyType) {
             case PropertyType.STRING:
             case PropertyType.REFERENCE:
@@ -216,14 +216,14 @@
             case PropertyType.LONG:
             case PropertyType.DECIMAL:
             case PropertyType.BINARY:
-                jcrString = qualifiedValue.getString();
+                jcrString = value.getString();
                 break;
             case PropertyType.PATH:
-                Path qPath = qualifiedValue.getPath();
+                Path qPath = value.getPath();
                 jcrString = resolver.getJCRPath(qPath);
                 break;
             case PropertyType.NAME:
-                Name qName = qualifiedValue.getName();
+                Name qName = value.getName();
                 jcrString = resolver.getJCRName(qName);
                 break;
             default:

Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/test/java/org/apache/jackrabbit/spi/commons/value/QValueTest.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/test/java/org/apache/jackrabbit/spi/commons/value/QValueTest.java?rev=785711&r1=785710&r2=785711&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-spi-commons/src/test/java/org/apache/jackrabbit/spi/commons/value/QValueTest.java
(original)
+++ jackrabbit/trunk/jackrabbit-spi-commons/src/test/java/org/apache/jackrabbit/spi/commons/value/QValueTest.java
Wed Jun 17 16:38:50 2009
@@ -256,19 +256,19 @@
     public void testDateValueEquality() throws RepositoryException {
         QValue v = factory.create(CALENDAR);
         QValue otherV = factory.create(CALENDAR);
-        assertEquals("Equality of qualified date value must be calculated based on their
String representation.", v, otherV);
+        assertEquals("Equality of date value must be calculated based on their String representation.",
v, otherV);
     }
 
     public void testDateValueEquality2() throws RepositoryException {
         QValue v = factory.create(CALENDAR);
         QValue otherV = factory.create(v.getString(), PropertyType.DATE);
-        assertEquals("Equality of qualified date value must be calculated based on their
String representation.", v, otherV);
+        assertEquals("Equality of date value must be calculated based on their String representation.",
v, otherV);
     }
 
     public void testDateValueStringRepresentation() throws RepositoryException {
         QValue v = factory.create(CALENDAR);
         String s = ISO8601.format(CALENDAR);
-        assertEquals("Expected String representation of qualified date value to be ISO8601
compliant.", s, v.getString());
+        assertEquals("Expected String representation of date value to be ISO8601 compliant.",
s, v.getString());
     }
 
     //----------------------------------------------------------< REFERENCE >---
@@ -290,7 +290,7 @@
     public void testReferenceValueEquality() throws RepositoryException {
         QValue v = factory.create(REFERENCE, PropertyType.REFERENCE);
         QValue otherV = factory.create(REFERENCE, PropertyType.REFERENCE);
-        assertEquals("Qualified ref values created from the same string must be equal.",
v, otherV);
+        assertEquals("Reference values created from the same string must be equal.", v, otherV);
     }
 
     public void testEqualityDifferentTypes() throws RepositoryException {
@@ -318,7 +318,7 @@
     public void testWeakReferenceValueEquality() throws RepositoryException {
         QValue v = factory.create(REFERENCE, PropertyType.WEAKREFERENCE);
         QValue otherV = factory.create(REFERENCE, PropertyType.WEAKREFERENCE);
-        assertEquals("Qualified ref values created from the same string must be equal.",
v, otherV);
+        assertEquals("Weak reference values created from the same string must be equal.",
v, otherV);
     }
 
     public void testEqualityDifferentTypes2() throws RepositoryException {
@@ -346,11 +346,11 @@
     public void testUriValueEquality() throws RepositoryException, URISyntaxException {
         QValue v = factory.create(URI_STRING, PropertyType.URI);
         QValue otherV = factory.create(URI_STRING, PropertyType.URI);
-        assertEquals("Qualified uri values created from the same string must be equal.",
v, otherV);
+        assertEquals("Uri values created from the same string must be equal.", v, otherV);
 
         URI uri = new URI(URI_STRING);
         v = factory.create(uri);
-        assertEquals("Qualified uri values created from the same string must be equal.",
v, otherV);
+        assertEquals("Uri values created from the same string must be equal.", v, otherV);
     }
 
     public void testEqualityDifferentTypes3() throws RepositoryException {



Mime
View raw message