You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by md...@apache.org on 2012/04/21 17:09:22 UTC
svn commit: r1328687 - in
/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit:
mk/client/ mk/fs/ mk/index/ mk/server/ oak/kernel/
Author: mduerig
Date: Sat Apr 21 15:09:22 2012
New Revision: 1328687
URL: http://svn.apache.org/viewvc?rev=1328687&view=rev
Log:
use {@code} instead of <code></code>
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Client.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/HttpExecutor.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Request.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FilePath.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FileUtils.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/index/BTree.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/HttpProcessor.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/MicroKernelServlet.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Request.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Response.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Server.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/kernel/AbstractChildNodeEntry.java
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Client.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Client.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Client.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Client.java Sat Apr 21 15:09:22 2012
@@ -31,7 +31,7 @@ import org.apache.jackrabbit.mk.api.Micr
import org.apache.jackrabbit.mk.util.IOUtils;
/**
- * Client exposing a <code>MicroKernel</code> interface, that "remotes" commands
+ * Client exposing a {@code MicroKernel} interface, that "remotes" commands
* to a server.
* <p/>
* All public methods inside this class are completely synchronized because
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/HttpExecutor.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/HttpExecutor.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/HttpExecutor.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/HttpExecutor.java Sat Apr 21 15:09:22 2012
@@ -16,6 +16,11 @@
*/
package org.apache.jackrabbit.mk.client;
+import org.apache.jackrabbit.mk.util.BoundedInputStream;
+import org.apache.jackrabbit.mk.util.ChunkedInputStream;
+import org.apache.jackrabbit.mk.util.ChunkedOutputStream;
+import org.apache.jackrabbit.mk.util.IOUtils;
+
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.Closeable;
@@ -30,11 +35,6 @@ import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Random;
-import org.apache.jackrabbit.mk.util.BoundedInputStream;
-import org.apache.jackrabbit.mk.util.ChunkedInputStream;
-import org.apache.jackrabbit.mk.util.ChunkedOutputStream;
-import org.apache.jackrabbit.mk.util.IOUtils;
-
/**
* Executes commands as HTTP requests.
* <p>
@@ -192,8 +192,8 @@ class HttpExecutor implements Closeable
/**
* Return a flag indicating whether the executor is alive.
- *
- * @return <code>true</code> if it is alive; <code>false</code> otherwise
+ *
+ * @return {@code true} if it is alive; {@code false} otherwise
*/
public boolean isAlive() {
return !connectionClosed && !socket.isClosed();
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Request.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Request.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Request.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/client/Request.java Sat Apr 21 15:09:22 2012
@@ -27,7 +27,7 @@ import java.util.concurrent.atomic.Atomi
import org.apache.jackrabbit.mk.util.IOUtils;
/**
- * Contains the details of a request to some remote <code>MicroKernel</code>
+ * Contains the details of a request to some remote {@code MicroKernel}
* implementation.
*/
class Request implements Closeable {
@@ -57,9 +57,9 @@ class Request implements Closeable {
/**
* Add a string parameter.
- *
+ *
* @param name name
- * @param value value, if <code>null</code> the call is ignored
+ * @param value value, if {@code null} the call is ignored
*/
public Request addParameter(String name, String value) {
if (value != null) {
@@ -70,8 +70,8 @@ class Request implements Closeable {
/**
* Add an integer parameter, equivalent to
- * <code>addParameter(name, String.valueOf(value))</code>.
- *
+ * {@code addParameter(name, String.valueOf(value))}.
+ *
* @param name name
* @param value value
*/
@@ -82,8 +82,8 @@ class Request implements Closeable {
/**
* Add a long parameter, equivalent to
- * <code>addParameter(name, String.valueOf(value))</code>.
- *
+ * {@code addParameter(name, String.valueOf(value))}.
+ *
* @param name name
* @param value value
*/
@@ -130,9 +130,9 @@ class Request implements Closeable {
/**
* Return a boolean from the result stream, equivalent to
- * <code>Boolean.parseBoolean(getString())</code>.
+ * {@code Boolean.parseBoolean(getString())}.
* Automatically executes the request first.
- *
+ *
* @return boolean
* @throws IOException if an I/O error occurs
*/
@@ -144,9 +144,9 @@ class Request implements Closeable {
/**
* Return a long from the result stream, equivalent to
- * <code>Long.parseLong(getString())</code>.
+ * {@code Long.parseLong(getString())}.
* Automatically executes the request first.
- *
+ *
* @return boolean
* @throws IOException if an I/O error occurs
*/
@@ -159,12 +159,12 @@ class Request implements Closeable {
/**
* Read bytes from the result stream. Automatically executes the
* request first.
- *
+ *
* @param b buffer
* @param off offset
* @param len length
- * @return number of bytes or <code>-1</code> if no more bytes are available
- *
+ * @return number of bytes or {@code -1} if no more bytes are available
+ *
* @throws IOException if an I/O error occurs
*/
public int read(byte[] b, int off, int len) throws IOException {
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FilePath.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FilePath.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FilePath.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FilePath.java Sat Apr 21 15:09:22 2012
@@ -28,10 +28,10 @@ import java.util.Random;
import org.apache.jackrabbit.mk.util.StringUtils;
/**
- * A path to a file. It similar to the Java 7 <code>java.nio.file.Path</code>,
+ * A path to a file. It similar to the Java 7 {@code java.nio.file.Path},
* but simpler, and works with older versions of Java. It also implements the
- * relevant methods found in <code>java.nio.file.FileSystem</code> and
- * <code>FileSystems</code>
+ * relevant methods found in {@code java.nio.file.FileSystem} and
+ * {@code FileSystems}
*/
public abstract class FilePath {
@@ -53,7 +53,7 @@ public abstract class FilePath {
/**
* Get the file path object for the given path.
- * This method is similar to Java 7 <code>java.nio.file.FileSystem.getPath</code>.
+ * This method is similar to Java 7 {@code java.nio.file.FileSystem.getPath}.
* Windows-style '\' is replaced with '/'.
*
* @param path the path
@@ -294,7 +294,7 @@ public abstract class FilePath {
/**
* Get the scheme (prefix) for this file provider.
- * This is similar to <code>java.nio.file.spi.FileSystemProvider.getScheme</code>.
+ * This is similar to {@code java.nio.file.spi.FileSystemProvider.getScheme}.
*
* @return the scheme
*/
@@ -302,7 +302,7 @@ public abstract class FilePath {
/**
* Convert a file to a path. This is similar to
- * <code>java.nio.file.spi.FileSystemProvider.getPath</code>, but may
+ * {@code java.nio.file.spi.FileSystemProvider.getPath}, but may
* return an object even if the scheme doesn't match in case of the the
* default file provider.
*
@@ -313,7 +313,7 @@ public abstract class FilePath {
/**
* Append an element to the path.
- * This is similar to <code>java.nio.file.spi.FileSystemProvider.resolve</code>.
+ * This is similar to {@code java.nio.file.spi.FileSystemProvider.resolve}.
*
* @param other the relative path (might be null)
* @return the resolved path
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FileUtils.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FileUtils.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FileUtils.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/fs/FileUtils.java Sat Apr 21 15:09:22 2012
@@ -38,7 +38,7 @@ public class FileUtils {
/**
* Checks if a file exists.
- * This method is similar to Java 7 <code>java.nio.file.Path.exists</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.exists}.
*
* @param fileName the file name
* @return true if it exists
@@ -49,7 +49,7 @@ public class FileUtils {
/**
* Create a directory (all required parent directories must already exist).
- * This method is similar to Java 7 <code>java.nio.file.Path.createDirectory</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.createDirectory}.
*
* @param directoryName the directory name
*/
@@ -59,7 +59,7 @@ public class FileUtils {
/**
* Create a new file.
- * This method is similar to Java 7 <code>java.nio.file.Path.createFile</code>, but returns
+ * This method is similar to Java 7 {@code java.nio.file.Path.createFile}, but returns
* false instead of throwing a exception if the file already existed.
*
* @param fileName the file name
@@ -72,7 +72,7 @@ public class FileUtils {
/**
* Delete a file or directory if it exists.
* Directories may only be deleted if they are empty.
- * This method is similar to Java 7 <code>java.nio.file.Path.deleteIfExists</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.deleteIfExists}.
*
* @param path the file or directory name
*/
@@ -82,7 +82,7 @@ public class FileUtils {
/**
* Get the canonical file or directory name.
- * This method is similar to Java 7 <code>java.nio.file.Path.toRealPath</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.toRealPath}.
*
* @param fileName the file name
* @return the normalized file name
@@ -94,7 +94,7 @@ public class FileUtils {
/**
* Get the parent directory of a file or directory.
* This method returns null if there is no parent.
- * This method is similar to Java 7 <code>java.nio.file.Path.getParent</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.getParent}.
*
* @param fileName the file or directory name
* @return the parent directory name
@@ -106,7 +106,7 @@ public class FileUtils {
/**
* Check if the file name includes a path.
- * This method is similar to Java 7 <code>java.nio.file.Path.isAbsolute</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.isAbsolute}.
*
* @param fileName the file name
* @return if the file name is absolute
@@ -117,7 +117,7 @@ public class FileUtils {
/**
* Rename a file if this is allowed.
- * This method is similar to Java 7 <code>java.nio.file.Path.moveTo</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.moveTo}.
*
* @param oldName the old fully qualified file name
* @param newName the new fully qualified file name
@@ -128,7 +128,7 @@ public class FileUtils {
/**
* Get the file or directory name (the last element of the path).
- * This method is similar to Java 7 <code>java.nio.file.Path.getName</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.getName}.
*
* @param path the directory and file name
* @return just the file name
@@ -139,7 +139,7 @@ public class FileUtils {
/**
* List the files and directories in the given directory.
- * This method is similar to Java 7 <code>java.nio.file.Path.newDirectoryStream</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.newDirectoryStream}.
*
* @param path the directory
* @return the list of fully qualified file names
@@ -157,7 +157,7 @@ public class FileUtils {
/**
* Get the last modified date of a file.
* This method is similar to Java 7
- * <code>java.nio.file.attribute.Attributes.readBasicFileAttributes(file).lastModified().toMillis()</code>
+ * {@code java.nio.file.attribute.Attributes.readBasicFileAttributes(file).lastModified().toMillis()}
*
* @param fileName the file name
* @return the last modified date
@@ -169,7 +169,7 @@ public class FileUtils {
/**
* Get the size of a file in bytes
* This method is similar to Java 7
- * <code>java.nio.file.attribute.Attributes.readBasicFileAttributes(file).size()</code>
+ * {@code java.nio.file.attribute.Attributes.readBasicFileAttributes(file).size()}
*
* @param fileName the file name
* @return the size in bytes
@@ -180,7 +180,7 @@ public class FileUtils {
/**
* Check if it is a file or a directory.
- * <code>java.nio.file.attribute.Attributes.readBasicFileAttributes(file).isDirectory()</code>
+ * {@code java.nio.file.attribute.Attributes.readBasicFileAttributes(file).isDirectory()}
*
* @param fileName the file or directory name
* @return true if it is a directory
@@ -191,7 +191,7 @@ public class FileUtils {
/**
* Open a random access file object.
- * This method is similar to Java 7 <code>java.nio.channels.FileChannel.open</code>.
+ * This method is similar to Java 7 {@code java.nio.channels.FileChannel.open}.
*
* @param fileName the file name
* @param mode the access mode. Supported are r, rw, rws, rwd
@@ -203,7 +203,7 @@ public class FileUtils {
/**
* Create an input stream to read from the file.
- * This method is similar to Java 7 <code>java.nio.file.Path.newInputStream</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.newInputStream}.
*
* @param fileName the file name
* @return the input stream
@@ -214,7 +214,7 @@ public class FileUtils {
/**
* Create an output stream to write into the file.
- * This method is similar to Java 7 <code>java.nio.file.Path.newOutputStream</code>.
+ * This method is similar to Java 7 {@code java.nio.file.Path.newOutputStream}.
*
* @param fileName the file name
* @param append if true, the file will grow, if false, the file will be
@@ -228,7 +228,7 @@ public class FileUtils {
/**
* Check if the file is writable.
* This method is similar to Java 7
- * <code>java.nio.file.Path.checkAccess(AccessMode.WRITE)</code>
+ * {@code java.nio.file.Path.checkAccess(AccessMode.WRITE)}
*
* @param fileName the file name
* @return if the file is writable
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/index/BTree.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/index/BTree.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/index/BTree.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/index/BTree.java Sat Apr 21 15:09:22 2012
@@ -21,7 +21,7 @@ import org.apache.jackrabbit.mk.util.Pat
/**
* A tree allows to query a value for a given key, similar to
- * <code>java.util.SortedMap</code>.
+ * {@code java.util.SortedMap}.
*/
public class BTree {
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/HttpProcessor.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/HttpProcessor.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/HttpProcessor.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/HttpProcessor.java Sat Apr 21 15:09:22 2012
@@ -88,11 +88,11 @@ class HttpProcessor {
/**
* Process a single request.
- *
+ *
* @param requestNum number of this request on the same persistent connection
- * @return <code>true</code> if the connection should be kept alive;
- * <code>false</code> otherwise
- *
+ * @return {@code true} if the connection should be kept alive;
+ * {@code false} otherwise
+ *
* @throws IOException if an I/O error occurs
*/
private boolean process(int requestNum) throws IOException {
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/MicroKernelServlet.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/MicroKernelServlet.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/MicroKernelServlet.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/MicroKernelServlet.java Sat Apr 21 15:09:22 2012
@@ -30,7 +30,7 @@ import org.apache.jackrabbit.mk.util.Mic
import org.apache.jackrabbit.mk.util.IOUtils;
/**
- * Servlet handling requests directed at a <code>MicroKernel</code> instance.
+ * Servlet handling requests directed at a {@code MicroKernel} instance.
*/
class MicroKernelServlet {
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Request.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Request.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Request.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Request.java Sat Apr 21 15:09:22 2012
@@ -106,8 +106,8 @@ class Request implements Closeable {
}
/**
- * Read a single line, terminated by a CR LF combination from an <code>InputStream</code>.
- *
+ * Read a single line, terminated by a CR LF combination from an {@code InputStream}.
+ *
* @return line
* @throws IOException if an I/O error occurs
*/
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Response.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Response.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Response.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Response.java Sat Apr 21 15:09:22 2012
@@ -213,7 +213,7 @@ class Response implements Closeable {
}
/**
- * Internal <code>OutputStream</code> passed to servlet handlers.
+ * Internal {@code OutputStream} passed to servlet handlers.
*/
class BodyOutputStream extends OutputStream {
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Server.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Server.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Server.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/mk/server/Server.java Sat Apr 21 15:09:22 2012
@@ -36,7 +36,7 @@ import org.apache.jackrabbit.mk.MicroKer
import org.apache.jackrabbit.mk.api.MicroKernel;
/**
- * Server exposing a <code>MicroKernel</code>.
+ * Server exposing a {@code MicroKernel}.
*/
public class Server {
@@ -195,7 +195,7 @@ public class Server {
/**
* Return the server's local socket address.
*
- * @return socket address or <code>null</code> if the server is not started
+ * @return socket address or {@code null} if the server is not started
*/
public InetSocketAddress getAddress() {
if (!started.get() || stopped.get()) {
Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/kernel/AbstractChildNodeEntry.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/kernel/AbstractChildNodeEntry.java?rev=1328687&r1=1328686&r2=1328687&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/kernel/AbstractChildNodeEntry.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/kernel/AbstractChildNodeEntry.java Sat Apr 21 15:09:22 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) {