Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManager.java Tue Sep 6 16:13:51 2011
@@ -36,13 +36,13 @@ import javax.jcr.version.Version;
import java.util.Iterator;
/**
- * VersionManager...
+ * {@code VersionManager}...
*/
public interface VersionManager {
/**
* @param nodeState
- * @return NodeEntry of newly created version
+ * @return {@code NodeEntry} of newly created version
* @throws VersionException
* @throws UnsupportedRepositoryOperationException
* @throws InvalidItemStateException
@@ -94,8 +94,8 @@ public interface VersionManager {
/**
* @param nodeState
- * @throws VersionException If the Node represented by the given
- * NodeState is checked in.
+ * @throws VersionException If the {@code Node} represented by the given
+ * {@code NodeState} is checked in.
* @throws RepositoryException If another error occurs.
* @see javax.jcr.Node#isCheckedOut()
*/
@@ -176,7 +176,7 @@ public interface VersionManager {
* @param nodeState
* @param workspaceName
* @param bestEffort
- * @return An Iterator over NodeIds of all Nodes
+ * @return An Iterator over NodeIds of all {@code Node}s
* that failed to be merged and need manual resolution by the user of the API.
* @throws NoSuchWorkspaceException
* @throws AccessDeniedException
@@ -184,7 +184,7 @@ public interface VersionManager {
* @throws LockException
* @throws InvalidItemStateException
* @throws RepositoryException
- * @see #resolveMergeConflict(NodeState,NodeState,boolean)
+ * @see #resolveMergeConflict(NodeState, NodeState, boolean)
* @see javax.jcr.Node#merge(String, boolean)
*/
Iterator merge(NodeState nodeState, String workspaceName, boolean bestEffort)
@@ -196,7 +196,7 @@ public interface VersionManager {
* @param workspaceName
* @param bestEffort
* @param isShallow
- * @return An Iterator over NodeIds of all Nodes
+ * @return An Iterator over NodeIds of all {@code Node}s
* that failed to be merged and need manual resolution by the user of the API.
* @throws NoSuchWorkspaceException
* @throws AccessDeniedException
@@ -204,7 +204,7 @@ public interface VersionManager {
* @throws LockException
* @throws InvalidItemStateException
* @throws RepositoryException
- * @see #resolveMergeConflict(NodeState,NodeState,boolean)
+ * @see #resolveMergeConflict(NodeState, NodeState, boolean)
* @see javax.jcr.Node#merge(String, boolean)
*/
Iterator merge(NodeState nodeState, String workspaceName, boolean bestEffort, boolean isShallow)
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManagerImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManagerImpl.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManagerImpl.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/version/VersionManagerImpl.java Tue Sep 6 16:13:51 2011
@@ -53,7 +53,7 @@ import org.apache.jackrabbit.spi.QValue;
import org.apache.jackrabbit.spi.commons.name.NameConstants;
/**
- * VersionManagerImpl...
+ * {@code VersionManagerImpl}...
*/
public class VersionManagerImpl implements VersionManager {
private final WorkspaceManager workspaceManager;
@@ -97,7 +97,7 @@ public class VersionManagerImpl implemen
/**
* Search nearest ancestor that is versionable. If no versionable ancestor
- * can be found, true is returned.
+ * can be found, {@code true} is returned.
*
* @param nodeState
* @return
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/DocViewImportHandler.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/DocViewImportHandler.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/DocViewImportHandler.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/DocViewImportHandler.java Tue Sep 6 16:13:51 2011
@@ -38,8 +38,8 @@ import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
/**
- * DocViewImportHandler processes Document View XML SAX events
- * and 'translates' them into {@link Importer} method calls.
+ * {@code DocViewImportHandler} processes Document View XML SAX events
+ * and 'translates' them into {@code }{@link Importer} method calls.
*/
class DocViewImportHandler extends TargetImportHandler {
private static final Logger log = LoggerFactory.getLogger(DocViewImportHandler.class);
@@ -56,7 +56,7 @@ class DocViewImportHandler extends Targe
private BufferedStringValue textHandler = new BufferedStringValue();
/**
- * Constructs a new DocViewImportHandler.
+ * Constructs a new {@code DocViewImportHandler}.
*
* @param importer
* @param resolver
@@ -93,10 +93,10 @@ class DocViewImportHandler extends Targe
/**
* Translates character data reported by the
- * {@link #characters(char[], int, int)} &
- * {@link #ignorableWhitespace(char[], int, int)} SAX events
- * into a jcr:xmltext child node with one
- * jcr:xmlcharacters property.
+ * {@code }{@link #characters(char[], int, int)} &
+ * {@code }{@link #ignorableWhitespace(char[], int, int)} SAX events
+ * into a {@code jcr:xmltext} child node with one
+ * {@code jcr:xmlcharacters} property.
*
* @throws SAXException if an error occurs
* @see #appendCharacters(char[], int, int)
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/ImportHandler.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/ImportHandler.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/ImportHandler.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/ImportHandler.java Tue Sep 6 16:13:51 2011
@@ -39,19 +39,19 @@ import org.xml.sax.helpers.DefaultHandle
import org.xml.sax.helpers.NamespaceSupport;
/**
- * An ImportHandler instance can be used to import serialized
+ * An {@code ImportHandler} instance can be used to import serialized
* data in System View XML or Document View XML. Processing of the XML is
- * handled by specialized ContentHandlers
- * (i.e. SysViewImportHandler and DocViewImportHandler).
+ * handled by specialized {@code ContentHandler}s
+ * (i.e. SysViewImportHandler and {@code DocViewImportHandler}).
*
* The actual task of importing though is delegated to the implementation of
- * the {@link Importer} interface.
+ * the {@code }{@link Importer} interface.
*
* Important Note:
*
* These SAX Event Handlers expect that Namespace URI's and local names are
- * reported in the start/endElement events and that
- * start/endPrefixMapping events are reported
+ * reported in the {@code start/endElement} events and that
+ * {@code start/endPrefixMapping} events are reported
* (i.e. default SAX2 Namespace processing).
*/
public class ImportHandler extends DefaultHandler {
@@ -239,7 +239,7 @@ public class ImportHandler extends Defau
//--------------------------------------------------------< inner classes >
/**
- * NamespaceContext supports scoped namespace declarations.
+ * {@code NamespaceContext} supports scoped namespace declarations.
*/
static class NamespaceContext implements NamespaceResolver {
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/Importer.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/Importer.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/Importer.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/Importer.java Tue Sep 6 16:13:51 2011
@@ -25,7 +25,7 @@ import java.io.Reader;
import java.util.List;
/**
- * The Importer interface ...
+ * The {@code Importer} interface ...
*/
public interface Importer {
@@ -36,7 +36,7 @@ public interface Importer {
/**
* @param nodeInfo
- * @param propInfos list of PropInfo instances
+ * @param propInfos list of {@code PropInfo} instances
* @param resolver NamePathResolver dealing with prefix mappings of current
* context.
* @throws RepositoryException
@@ -116,7 +116,7 @@ public interface Importer {
}
/**
- * TextValue represents a serialized property value read
+ * {@code TextValue} represents a serialized property value read
* from a System or Document View XML document.
*/
interface TextValue {
@@ -137,9 +137,9 @@ public interface Importer {
String retrieve() throws IOException;
/**
- * Returns a Reader for reading the serialized value.
+ * Returns a {@code Reader} for reading the serialized value.
*
- * @return a Reader for reading the serialized value.
+ * @return a {@code Reader} for reading the serialized value.
* @throws IOException if an I/O error occurs
*/
Reader reader() throws IOException;
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/SessionImporter.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/SessionImporter.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/SessionImporter.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/SessionImporter.java Tue Sep 6 16:13:51 2011
@@ -73,7 +73,7 @@ import java.util.Stack;
import java.util.UUID;
/**
- * SessionImporter...
+ * {@code SessionImporter}...
*/
public class SessionImporter implements Importer, SessionListener {
private static final Logger log = LoggerFactory.getLogger(SessionImporter.class);
@@ -96,17 +96,17 @@ public class SessionImporter implements
private final ReferenceChangeTracker refTracker;
/**
- * Creates a new WorkspaceImporter instance.
+ * Creates a new {@code WorkspaceImporter} instance.
*
* @param parentPath Path of target node where to add the imported
* sub-tree.
* @param session
* @param uuidBehavior Flag that governs how incoming UUIDs are handled.
- * @throws PathNotFoundException If no node exists at parentPath
+ * @throws PathNotFoundException If no node exists at {@code parentPath}
* or if the current session is not granted read access.
- * @throws ConstraintViolationException If the node at parentPath
+ * @throws ConstraintViolationException If the node at {@code parentPath}
* is protected.
- * @throws VersionException If the node at parentPath is not
+ * @throws VersionException If the node at {@code parentPath} is not
* checked-out.
* @throws LockException If a lock prevents the addition of the sub-tree.
* @throws RepositoryException If another error occurs.
@@ -538,7 +538,7 @@ public class SessionImporter implements
* @param propertyInfo
* @param targetType
* @param isMultiple
- * @param resolver The name/path resolver used to build QValues.
+ * @param resolver The name/path resolver used to build {@code QValue}s.
* @return
* @throws RepositoryException
*/
@@ -562,7 +562,7 @@ public class SessionImporter implements
*
* @param tv
* @param targetType
- * @param resolver The name/path resolver used to build a QValue.
+ * @param resolver The name/path resolver used to build a {@code QValue}.
* @return
* @throws RepositoryException
*/
@@ -610,7 +610,7 @@ public class SessionImporter implements
}
/**
- * Validate the given NodeInfo: make sure, that if a uuid is
+ * Validate the given {@code NodeInfo}: make sure, that if a uuid is
* defined, the primary or the mixin types include mix:referenceable.
*
* @param nodeInfo
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/SysViewImportHandler.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/SysViewImportHandler.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/SysViewImportHandler.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/SysViewImportHandler.java Tue Sep 6 16:13:51 2011
@@ -35,23 +35,23 @@ import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
/**
- * SysViewImportHandler ...
+ * {@code SysViewImportHandler} ...
*/
class SysViewImportHandler extends TargetImportHandler {
- /** Local part of sv:node. */
+ /** Local part of {@code sv:node}. */
private static final String NODE = "node";
- /** Local part of sv:property. */
+ /** Local part of {@code sv:property}. */
private static final String PROPERTY = "property";
- /** Local part of sv:value. */
+ /** Local part of {@code sv:value}. */
private static final String VALUE = "value";
- /** Local part of sv:name. */
+ /** Local part of {@code sv:name}. */
private static final String NAME = "name";
- /** Local part of sv:type. */
+ /** Local part of {@code sv:type}. */
private static final String TYPE = "type";
/**
@@ -73,7 +73,7 @@ class SysViewImportHandler extends Targe
private AppendableValue currentPropValue;
/**
- * Constructs a new SysViewImportHandler.
+ * Constructs a new {@code SysViewImportHandler}.
*
* @param importer
* @param resolver
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/TargetImportHandler.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/TargetImportHandler.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/TargetImportHandler.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/TargetImportHandler.java Tue Sep 6 16:13:51 2011
@@ -35,9 +35,9 @@ import java.io.StringReader;
import java.io.Writer;
/**
- * TargetImportHandler serves as the base class for the concrete
- * classes {@link DocViewImportHandler} and
- * {@link SysViewImportHandler}.
+ * {@code TargetImportHandler} serves as the base class for the concrete
+ * classes {@code }{@link DocViewImportHandler} and
+ * {@code }{@link SysViewImportHandler}.
*/
abstract class TargetImportHandler extends DefaultHandler {
private static final Logger log = LoggerFactory.getLogger(TargetImportHandler.class);
@@ -51,7 +51,7 @@ abstract class TargetImportHandler exten
}
/**
- * Disposes all instances of AppendableValue contained in the
+ * Disposes all instances of {@code AppendableValue} contained in the
* given property info's value array.
*
* @param prop property info
@@ -106,12 +106,12 @@ abstract class TargetImportHandler exten
//--------------------------------------------------------< inner classes >
/**
- * AppendableValue represents a serialized value that is
+ * {@code AppendableValue} represents a serialized value that is
* appendable.
*
* Important: Note that in order to free resources
- * {@link #dispose()} should be called as soon as an
- * AppendableValue object is not used anymore.
+ * {@code }{@link #dispose()} should be called as soon as an
+ * {@code AppendableValue} object is not used anymore.
*/
public interface AppendableValue extends Importer.TextValue {
/**
@@ -143,14 +143,14 @@ abstract class TargetImportHandler exten
}
/**
- * StringValue represents an immutable serialized value.
+ * {@code StringValue} represents an immutable serialized value.
*/
protected static class StringValue implements Importer.TextValue {
private final String value;
/**
- * Constructs a new StringValue representing the given
+ * Constructs a new {@code StringValue} representing the given
* value.
*
* @param value
@@ -178,13 +178,13 @@ abstract class TargetImportHandler exten
}
/**
- * BufferedStringValue represents an appendable
+ * {@code BufferedStringValue} represents an appendable
* serialized value that is either buffered in-memory or backed
* by a temporary file if its size exceeds a certain limit.
*
* Important: Note that in order to free resources
- * {@link #dispose()} should be called as soon as
- * BufferedStringValue instance is not used anymore.
+ * {@code }{@link #dispose()} should be called as soon as
+ * {@code BufferedStringValue} instance is not used anymore.
*/
protected class BufferedStringValue implements AppendableValue {
@@ -221,7 +221,7 @@ abstract class TargetImportHandler exten
private Writer writer;
/**
- * Constructs a new empty BufferedStringValue.
+ * Constructs a new empty {@code BufferedStringValue}.
*/
protected BufferedStringValue() {
buffer = new char[0x2000];
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/WorkspaceContentHandler.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/WorkspaceContentHandler.java?rev=1165743&r1=1165742&r2=1165743&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/WorkspaceContentHandler.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/xml/WorkspaceContentHandler.java Tue Sep 6 16:13:51 2011
@@ -35,7 +35,7 @@ import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
/**
- * WorkspaceContentHandler...
+ * {@code WorkspaceContentHandler}...
*/
public class WorkspaceContentHandler extends DefaultHandler {
private final String parentAbsPath;