You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by ju...@apache.org on 2006/08/01 11:20:26 UTC

svn commit: r427500 - in /jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit: core/query/ core/query/sql/ core/query/xpath/ name/ value/

Author: jukka
Date: Tue Aug  1 02:20:26 2006
New Revision: 427500

URL: http://svn.apache.org/viewvc?rev=427500&view=rev
Log:
JCR-73: Applied javadoc cleanups contributed by Julian Reschke.

Modified:
    jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/LocationStepQueryNode.java
    jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/sql/JCRSQLQueryBuilder.java
    jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/xpath/XPathQueryBuilder.java
    jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/name/Path.java
    jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueFactoryImpl.java
    jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueHelper.java

Modified: jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/LocationStepQueryNode.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/LocationStepQueryNode.java?rev=427500&r1=427499&r2=427500&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/LocationStepQueryNode.java (original)
+++ jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/LocationStepQueryNode.java Tue Aug  1 02:20:26 2006
@@ -120,7 +120,7 @@
     /**
      * Sets a new value for the includeDescendants property.
      * @param include the new value.
-     * @see {@link #getIncludeDescendants()}
+     * @see #getIncludeDescendants()
      */
     public void setIncludeDescendants(boolean include) {
         this.includeDescendants = include;

Modified: jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/sql/JCRSQLQueryBuilder.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/sql/JCRSQLQueryBuilder.java?rev=427500&r1=427499&r2=427500&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/sql/JCRSQLQueryBuilder.java (original)
+++ jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/sql/JCRSQLQueryBuilder.java Tue Aug  1 02:20:26 2006
@@ -63,7 +63,7 @@
 
     /**
      * DateFormat pattern for type
-     * {@link org.apache.jackrabbit.core.query.QueryConstants.TYPE_DATE}.
+     * {@link org.apache.jackrabbit.core.query.QueryConstants#TYPE_DATE}.
      */
     private static final String DATE_PATTERN = "yyyy-MM-dd";
 

Modified: jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/xpath/XPathQueryBuilder.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/xpath/XPathQueryBuilder.java?rev=427500&r1=427499&r2=427500&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/xpath/XPathQueryBuilder.java (original)
+++ jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/query/xpath/XPathQueryBuilder.java Tue Aug  1 02:20:26 2006
@@ -886,7 +886,7 @@
      * Returns true if <code>node</code> has a child node which is the attribute
      * axis.
      *
-     * @param node a node with type {@link org.apache.jackrabbit.core.query.xpath.XPathTreeConstants.JJTSTEPEXPR}.
+     * @param node a node with type {@link org.apache.jackrabbit.core.query.xpath.XPathTreeConstants#JJTSTEPEXPR}.
      * @return <code>true</code> if this step expression uses the attribute axis.
      */
     private boolean isAttributeAxis(SimpleNode node) {

Modified: jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/name/Path.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/name/Path.java?rev=427500&r1=427499&r2=427500&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/name/Path.java (original)
+++ jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/name/Path.java Tue Aug  1 02:20:26 2006
@@ -165,7 +165,6 @@
      * @param jcrPath
      * @param resolver
      * @param normalize
-     * @return
      * @throws MalformedPathException
      * @deprecated Use PathFormat#parse(String, NamespaceResolver)} instead.
      */
@@ -189,7 +188,6 @@
      * @param relJCRPath
      * @param resolver
      * @param canonicalize
-     * @return
      * @throws MalformedPathException
      * @deprecated Use {@link PathFormat#parse(Path, String, NamespaceResolver)} instead.
      */
@@ -213,7 +211,6 @@
      * @param parent
      * @param relPath
      * @param normalize
-     * @return
      * @throws MalformedPathException if <code>relPath</code> is absolute
      */
     public static Path create(Path parent, Path relPath, boolean normalize)
@@ -991,8 +988,8 @@
         /**
          * Creates a new path element with the given qualified name and index.
          * If the name is equals to the name of a special element, like the
-         * {@link PARENT_ELEMENT},{@link CURRENT_ELEMENT} or the
-         * {@link ROOT_ELEMENT}, then it's instance is returned.
+         * {@link #PARENT_ELEMENT},{@link #CURRENT_ELEMENT} or the
+         * {@link #ROOT_ELEMENT}, then it's instance is returned.
          * <p/>
          * the private constructor must never be called but from these 2 methods.
          *
@@ -1017,8 +1014,8 @@
         /**
          * Creates a new path element with the given qualified name and index.
          * If the name is equals to the name of a special element, like the
-         * {@link PARENT_ELEMENT},{@link CURRENT_ELEMENT} or the
-         * {@link ROOT_ELEMENT}, then it's instance is returned.
+         * {@link #PARENT_ELEMENT},{@link #CURRENT_ELEMENT} or the
+         * {@link #ROOT_ELEMENT}, then it's instance is returned.
          * <p/>
          * the private constructor must never be called but from these 2 methods.
          *
@@ -1271,7 +1268,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesName()
+         * @see Path.PathElement#denotesName()
          */
         public boolean denotesName() {
             return false;
@@ -1281,7 +1278,7 @@
          * Returns true.
          *
          * @return true
-         * @see PathElement#denotesRoot()
+         * @see Path.PathElement#denotesRoot()
          */
         public boolean denotesRoot() {
             return true;
@@ -1291,7 +1288,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesParent()
+         * @see Path.PathElement#denotesParent()
          */
         public boolean denotesParent() {
             return false;
@@ -1301,7 +1298,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesCurrent()
+         * @see Path.PathElement#denotesCurrent()
          */
         public boolean denotesCurrent() {
             return false;
@@ -1345,7 +1342,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesName()
+         * @see Path.PathElement#denotesName()
          */
         public boolean denotesName() {
             return false;
@@ -1355,7 +1352,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesRoot()
+         * @see Path.PathElement#denotesRoot()
          */
         public boolean denotesRoot() {
             return false;
@@ -1365,7 +1362,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesParent()
+         * @see Path.PathElement#denotesParent()
          */
         public boolean denotesParent() {
             return false;
@@ -1375,7 +1372,7 @@
          * Returns true.
          *
          * @return true
-         * @see PathElement#denotesCurrent()
+         * @see Path.PathElement#denotesCurrent()
          */
         public boolean denotesCurrent() {
             return true;
@@ -1418,7 +1415,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesName()
+         * @see Path.PathElement#denotesName()
          */
         public boolean denotesName() {
             return false;
@@ -1428,7 +1425,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesRoot()
+         * @see Path.PathElement#denotesRoot()
          */
         public boolean denotesRoot() {
             return false;
@@ -1438,7 +1435,7 @@
          * Returns true.
          *
          * @return true
-         * @see PathElement#denotesParent()
+         * @see Path.PathElement#denotesParent()
          */
         public boolean denotesParent() {
             return true;
@@ -1448,7 +1445,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesCurrent()
+         * @see Path.PathElement#denotesCurrent()
          */
         public boolean denotesCurrent() {
             return false;
@@ -1490,7 +1487,7 @@
          * Returns true.
          *
          * @return true
-         * @see PathElement#denotesName()
+         * @see Path.PathElement#denotesName()
          */
         public boolean denotesName() {
             return true;
@@ -1500,7 +1497,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesRoot()
+         * @see Path.PathElement#denotesRoot()
          */
         public boolean denotesRoot() {
             return false;
@@ -1510,7 +1507,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesParent()
+         * @see Path.PathElement#denotesParent()
          */
         public boolean denotesParent() {
             return false;
@@ -1520,7 +1517,7 @@
          * Returns false.
          *
          * @return false
-         * @see PathElement#denotesCurrent()
+         * @see Path.PathElement#denotesCurrent()
          */
         public boolean denotesCurrent() {
             return false;

Modified: jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueFactoryImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueFactoryImpl.java?rev=427500&r1=427499&r2=427500&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueFactoryImpl.java (original)
+++ jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueFactoryImpl.java Tue Aug  1 02:20:26 2006
@@ -43,7 +43,6 @@
     //--------------------------------------------------------------------------
     /**
      *
-     * @return
      */
     public static ValueFactory getInstance() {
         return valueFactory;

Modified: jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueHelper.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueHelper.java?rev=427500&r1=427499&r2=427500&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueHelper.java (original)
+++ jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/value/ValueHelper.java Tue Aug  1 02:20:26 2006
@@ -54,7 +54,6 @@
      *
      * @param srcValue
      * @param targetType
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      * @deprecated Use {@link #convert(String, int, ValueFactory)} instead.
@@ -69,7 +68,6 @@
      * @param srcValue
      * @param targetType
      * @param factory
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      * @see #convert(Value, int, ValueFactory)
@@ -89,7 +87,6 @@
      *
      * @param srcValue
      * @param targetType
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      * @deprecated Use {@link #convert(InputStream, int, ValueFactory)} instead.
@@ -103,7 +100,6 @@
      * @param srcValue
      * @param targetType
      * @param factory
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      */
@@ -122,7 +118,6 @@
      *
      * @param srcValues
      * @param targetType
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      * @deprecated Use {@link #convert(String[], int, ValueFactory)} instead.
@@ -139,7 +134,6 @@
      *
      * @param srcValues
      * @param targetType
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      * @see #convert(Value, int, ValueFactory)
@@ -159,7 +153,6 @@
     /**
      * @param srcValues
      * @param targetType
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      * @see #convert(Value, int, ValueFactory)
@@ -183,7 +176,6 @@
      *
      * @param srcValues
      * @param targetType
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      * @deprecated Use {@link #convert(Value[], int, ValueFactory)} instead.
@@ -198,7 +190,6 @@
      * @param srcValues
      * @param targetType
      * @param factory
-     * @return
      * @throws ValueFormatException
      * @throws IllegalArgumentException
      * @see #convert(Value, int, ValueFactory)
@@ -237,7 +228,6 @@
 
      * @param srcValue
      * @param targetType
-     * @return
      * @throws ValueFormatException
      * @throws IllegalStateException
      * @throws IllegalArgumentException
@@ -258,7 +248,6 @@
      * @param srcValue
      * @param targetType
      * @param factory
-     * @return
      * @throws ValueFormatException
      * @throws IllegalStateException
      * @throws IllegalArgumentException
@@ -469,7 +458,6 @@
      * Same as {@link #copy(Value, ValueFactory)} using <code>ValueFactoryImpl</code>.
      *
      * @param srcValue
-     * @return
      * @throws IllegalStateException
      * @deprecated Use {@link #copy(Value, ValueFactory)} instead.
      */
@@ -481,7 +469,6 @@
      *
      * @param srcValue
      * @param factory
-     * @return
      * @throws IllegalStateException
      */
     public static Value copy(Value srcValue, ValueFactory factory)
@@ -533,7 +520,6 @@
      * Same as {@link #copy(Value[], ValueFactory)} using <code>ValueFactoryImpl</code>.
      *
      * @param srcValues
-     * @return
      * @throws IllegalStateException
      * @deprecated Use {@link #copy(Value[], ValueFactory)} instead.
      */
@@ -544,7 +530,6 @@
     /**
      * @param srcValues
      * @param factory
-     * @return
      * @throws IllegalStateException
      */
     public static Value[] copy(Value[] srcValues, ValueFactory factory)