jackrabbit-oak-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject svn commit: r1327549 - in /jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk: api/ core/ model/ persistence/ store/ util/
Date Wed, 18 Apr 2012 15:47:12 GMT
Author: stefan
Date: Wed Apr 18 15:47:12 2012
New Revision: 1327549

URL: http://svn.apache.org/viewvc?rev=1327549&view=rev
Log:
javadoc: replace <code/> with {@code}

Modified:
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/api/MicroKernelException.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/core/MicroKernelImpl.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractChildNodeEntry.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractNodeState.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/ChildNodeEntries.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/CommitBuilder.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/Id.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/NodeState.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/persistence/GCPersistence.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/DefaultRevisionStore.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/IdFactory.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/BoundedInputStream.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/ChunkedOutputStream.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/IOUtils.java
    jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/PathUtils.java

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/api/MicroKernelException.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/api/MicroKernelException.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/api/MicroKernelException.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/api/MicroKernelException.java
Wed Apr 18 15:47:12 2012
@@ -17,7 +17,7 @@
 package org.apache.jackrabbit.mk.api;
 
 /**
- * Exception thrown by methods of the <code>MicroKernel</code> API
+ * Exception thrown by methods of the {@code MicroKernel} API
  */
 public class MicroKernelException extends RuntimeException {
 

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/core/MicroKernelImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/core/MicroKernelImpl.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/core/MicroKernelImpl.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/core/MicroKernelImpl.java
Wed Apr 18 15:47:12 2012
@@ -96,7 +96,7 @@ public class MicroKernelImpl implements 
     }
     
     /**
-     * Same as <code>getHeadRevisionId</code>, with typed <code>Id</code>
return value instead of string.
+     * Same as {@code getHeadRevisionId}, with typed {@code Id} return value instead of string.
      * 
      * @see #getHeadRevision()
      */

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractChildNodeEntry.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractChildNodeEntry.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractChildNodeEntry.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractChildNodeEntry.java
Wed Apr 18 15:47:12 2012
@@ -31,8 +31,8 @@ public abstract class AbstractChildNodeE
      * equality check if one is available.
      *
      * @param that target of the comparison
-     * @return <code>true</code> if the objects are equal,
-     *         <code>false</code> otherwise
+     * @return {@code true} if the objects are equal,
+     *         {@code false} otherwise
      */
     @Override
     public boolean equals(Object that) {

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractNodeState.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractNodeState.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractNodeState.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/AbstractNodeState.java
Wed Apr 18 15:47:12 2012
@@ -78,8 +78,8 @@ public abstract class AbstractNodeState 
      * more efficient equality check if one is available.
      *
      * @param that target of the comparison
-     * @return <code>true</code> if the objects are equal,
-     *         <code>false</code> otherwise
+     * @return {@code true} if the objects are equal,
+     *         {@code false} otherwise
      */
     @Override
     public boolean equals(Object that) {

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/ChildNodeEntries.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/ChildNodeEntries.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/ChildNodeEntries.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/ChildNodeEntries.java
Wed Apr 18 15:47:12 2012
@@ -52,8 +52,8 @@ public interface ChildNodeEntries extend
     //-------------------------------------------------------------< diff ops >
 
     /**
-     * Returns those entries that exist in <code>other</code> but not in
-     * <code>this</code>.
+     * Returns those entries that exist in {@code other} but not in
+     * {@code this}.
      *
      * @param other
      * @return
@@ -61,8 +61,8 @@ public interface ChildNodeEntries extend
     Iterator<ChildNode> getAdded(final ChildNodeEntries other);
 
     /**
-     * Returns those entries that exist in <code>this</code> but not in
-     * <code>other</code>.
+     * Returns those entries that exist in {@code this} but not in
+     * {@code other}.
      *
      * @param other
      * @return
@@ -70,8 +70,8 @@ public interface ChildNodeEntries extend
     Iterator<ChildNode> getRemoved(final ChildNodeEntries other);
 
     /**
-     * Returns <code>this</code> instance's entries that have namesakes in
-     * <code>other</code> but with different <code>id</code>s.
+     * Returns {@code this} instance's entries that have namesakes in
+     * {@code other} but with different {@code id}s.
      *
      * @param other
      * @return

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/CommitBuilder.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/CommitBuilder.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/CommitBuilder.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/CommitBuilder.java
Wed Apr 18 15:47:12 2012
@@ -332,8 +332,8 @@ public class CommitBuilder {
     }
 
     /**
-     * Performs a three-way merge of the trees rooted at <code>ourRoot</code>,
-     * <code>theirRoot</code>, using the tree at <code>baseRoot</code>
as reference.
+     * Performs a three-way merge of the trees rooted at {@code ourRoot},
+     * {@code theirRoot}, using the tree at {@code baseRoot} as reference.
      *
      * @param baseRoot
      * @param ourRoot

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/Id.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/Id.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/Id.java (original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/Id.java Wed Apr
18 15:47:12 2012
@@ -29,9 +29,9 @@ import java.util.Arrays;
  * or the string representation.
  * <p/>
  * <b>Important Note:</b><p/>
- * An {@link Id} is considered immutable. The <code>byte[]</code> 
+ * An {@link Id} is considered immutable. The {@code byte[]}
  * passed to {@link Id#Id(byte[])} must not be reused or modified, the same
- * applies for the <code>byte[]</code> returned by {@link Id#getBytes()}.
+ * applies for the {@code byte[]} returned by {@link Id#getBytes()}.
  */
 public class Id implements Comparable<Id> {
 
@@ -39,10 +39,10 @@ public class Id implements Comparable<Id
     private final byte[] raw;
 
     /**
-     * Creates a new instance based on the passed <code>byte[]</code>.
+     * Creates a new instance based on the passed {@code byte[]}.
      * <p/>
-     * The passed <code>byte[]</code> mus not be reused, it's assumed
-     * to be owned by the new <code>Id</code> instance.
+     * The passed {@code byte[]} mus not be reused, it's assumed
+     * to be owned by the new {@code Id} instance.
      *
      * @param raw the byte representation
      */
@@ -52,7 +52,7 @@ public class Id implements Comparable<Id
     }
 
     /**
-     * Creates an <code>Id</code> instance from its
+     * Creates an {@code Id} instance from its
      * string representation as returned by {@link #toString()}.
      * <p/>
      * The following condition holds true:
@@ -61,8 +61,8 @@ public class Id implements Comparable<Id
      * assert(Id.fromString(someId.toString()).equals(someId));
      * </pre>
      *
-     * @param s a string representation of an <code>Id</code>
-     * @return an <code>Id</code> instance
+     * @param s a string representation of an {@code Id}
+     * @return an {@code Id} instance
      */
     public static Id fromString(String s) {
         return new Id(StringUtils.convertHexToBytes(s));
@@ -105,7 +105,7 @@ public class Id implements Comparable<Id
     /**
      * Returns the raw byte representation of this identifier.
      * <p/>
-     * The returned <code>byte[]</code> <i>MUST NOT</i> be modified!
+     * The returned {@code byte[]} <i>MUST NOT</i> be modified!
      *
      * @return the raw byte representation
      */

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/NodeState.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/NodeState.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/NodeState.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/model/NodeState.java
Wed Apr 18 15:47:12 2012
@@ -94,12 +94,12 @@ public interface NodeState {
      * is not parsed or otherwise interpreted by this method.
      * <p>
      * The namespace of properties and child nodes is shared, so if
-     * this method returns a non-<code>null</code> value for a given
+     * this method returns a non-{@code null} value for a given
      * name, then {@link #getChildNode(String)} is guaranteed to return
-     * <code>null</code> for the same name.
+     * {@code null} for the same name.
      *
      * @param name name of the property to return
-     * @return named property, or <code>null</code> if not found
+     * @return named property, or {@code null} if not found
      */
     PropertyState getProperty(String name);
 
@@ -125,12 +125,12 @@ public interface NodeState {
      * is not parsed or otherwise interpreted by this method.
      * <p>
      * The namespace of properties and child nodes is shared, so if
-     * this method returns a non-<code>null</code> value for a given
+     * this method returns a non-{@code null} value for a given
      * name, then {@link #getProperty(String)} is guaranteed to return
-     * <code>null</code> for the same name.
+     * {@code null} for the same name.
      *
      * @param name name of the child node to return
-     * @return named child node, or <code>null</code> if not found
+     * @return named child node, or {@code null} if not found
      */
     NodeState getChildNode(String name);
 

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/persistence/GCPersistence.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/persistence/GCPersistence.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/persistence/GCPersistence.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/persistence/GCPersistence.java
Wed Apr 18 15:47:12 2012
@@ -37,8 +37,8 @@ public interface GCPersistence extends P
      * 
      * @param id
      *            commit id
-     * @return <code>true</code> if the commit was not marked before;
-     *         <code>false</code> otherwise
+     * @return {@code true} if the commit was not marked before;
+     *         {@code false} otherwise
      * 
      * @throws Exception if an error occurs
      */
@@ -49,8 +49,8 @@ public interface GCPersistence extends P
      * 
      * @param id
      *            node id
-     * @return <code>true</code> if the node was not marked before;
-     *         <code>false</code> otherwise
+     * @return {@code true} if the node was not marked before;
+     *         {@code false} otherwise
      * 
      * @throws Exception if an error occurs
      */
@@ -61,8 +61,8 @@ public interface GCPersistence extends P
      * 
      * @param id
      *            child node entry map id
-     * @return <code>true</code> if the child node entry map was not marked before;
-     *         <code>false</code> otherwise
+     * @return {@code true} if the child node entry map was not marked before;
+     *         {@code false} otherwise
      * 
      * @throws Exception if an error occurs
      */

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/DefaultRevisionStore.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/DefaultRevisionStore.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/DefaultRevisionStore.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/DefaultRevisionStore.java
Wed Apr 18 15:47:12 2012
@@ -38,8 +38,8 @@ import org.apache.jackrabbit.mk.util.IOU
 import org.apache.jackrabbit.mk.util.SimpleLRUCache;
 
 /**
- * Default revision store implementation, passing calls to a <code>Persistence</code>
- * and a <code>BlobStore</code>, respectively and providing caching. 
+ * Default revision store implementation, passing calls to a {@code Persistence}
+ * and a {@code BlobStore}, respectively and providing caching.
  */
 public class DefaultRevisionStore extends AbstractRevisionStore
         implements Closeable {

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/IdFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/IdFactory.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/IdFactory.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/store/IdFactory.java
Wed Apr 18 15:47:12 2012
@@ -26,9 +26,9 @@ public abstract class IdFactory {
     /**
      * Creates a new id based on the specified serialized data.
      * <p/>
-     * The general contract of <code>createContentId</code> is:
+     * The general contract of {@code createContentId} is:
      * <p/>
-     * <code>createId(data1).equals(createId(data2)) == Arrays.equals(data1, data2)</code>
+     * {@code createId(data1).equals(createId(data2)) == Arrays.equals(data1, data2)}
      *
      * @param serialized serialized data
      * @return raw node id as byte array

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/BoundedInputStream.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/BoundedInputStream.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/BoundedInputStream.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/BoundedInputStream.java
Wed Apr 18 15:47:12 2012
@@ -21,8 +21,8 @@ import java.io.IOException;
 import java.io.InputStream;
 
 /**
- * Implementation of an <code>InputStream</code> that is bounded by a limit
- * and will return <code>-1</code> on reads when this limit is exceeded.
+ * Implementation of an {@code InputStream} that is bounded by a limit
+ * and will return {@code -1} on reads when this limit is exceeded.
  */
 public class BoundedInputStream extends FilterInputStream {
     

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/ChunkedOutputStream.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/ChunkedOutputStream.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/ChunkedOutputStream.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/ChunkedOutputStream.java
Wed Apr 18 15:47:12 2012
@@ -58,8 +58,8 @@ public class ChunkedOutputStream extends
      *
      * @param out underlying output stream.
      * @param size internal buffer size
-     * @throws IllegalArgumentException if <code>size</code> is smaller than
1
-     *         or bigger than <code>65535</code>
+     * @throws IllegalArgumentException if {@code size} is smaller than 1
+     *         or bigger than {@code 65535}
      */
     public ChunkedOutputStream(OutputStream out, int size) {
         super(out);
@@ -169,7 +169,7 @@ public class ChunkedOutputStream extends
      * Close this output stream. Flush the contents of the internal buffer
      * and writes the last chunk to the underlying output stream. Sets
      * the internal reference to the underlying output stream to 
-     * <code>null</code>. Does <b>not</b> close the underlying output
stream.
+     * {@code null}. Does <b>not</b> close the underlying output stream.
      *
      * @see java.io.FilterOutputStream#close()
      */

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/IOUtils.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/IOUtils.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/IOUtils.java (original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/IOUtils.java Wed
Apr 18 15:47:12 2012
@@ -269,7 +269,7 @@ public class IOUtils {
     }
 
     /**
-     * Unconditionally close a <code>Closeable</code>.
+     * Unconditionally close a {@code Closeable}.
      * <p>
      * Equivalent to {@link Closeable#close()}, except any exceptions will be ignored.
      * This is typically used in finally blocks.
@@ -287,7 +287,7 @@ public class IOUtils {
     }
 
     /**
-     * Unconditionally close a <code>Socket</code>.
+     * Unconditionally close a {@code Socket}.
      * <p>
      * Equivalent to {@link Socket#close()}, except any exceptions will be ignored.
      * This is typically used in finally blocks.
@@ -305,14 +305,14 @@ public class IOUtils {
     }
 
     /**
-     * Copy bytes from an <code>InputStream</code> to an
-     * <code>OutputStream</code>.
+     * Copy bytes from an {@code InputStream} to an
+     * {@code OutputStream}.
      * <p>
      * This method buffers the input internally, so there is no need to use a
-     * <code>BufferedInputStream</code>.
+     * {@code BufferedInputStream}.
      *
-     * @param input  the <code>InputStream</code> to read from
-     * @param output  the <code>OutputStream</code> to write to
+     * @param input  the {@code InputStream} to read from
+     * @param output  the {@code OutputStream} to write to
      * @return the number of bytes copied
      * @throws IOException if an I/O error occurs
      */

Modified: jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/PathUtils.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/PathUtils.java?rev=1327549&r1=1327548&r2=1327549&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/PathUtils.java
(original)
+++ jackrabbit/oak/trunk/oak-mk/src/main/java/org/apache/jackrabbit/mk/util/PathUtils.java
Wed Apr 18 15:47:12 2012
@@ -335,7 +335,7 @@ public class PathUtils {
 
     /**
      * Relativize a path wrt. a parent path such that
-     * <code>relativize(parentPath, concat(parentPath, path)) == paths</code>
+     * {@code relativize(parentPath, concat(parentPath, path)) == paths}
      * holds.
      *
      * @param parentPath parent pth



Mime
View raw message