You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by md...@apache.org on 2011/09/07 11:49:40 UTC
svn commit: r1166087 [2/3] - in /jackrabbit/sandbox/jackrabbit-mk:
jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/
jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/hierarchy/
jackrabbit-jcr2spi/src/main/java/org/apache/jac...
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/EventFilter.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/EventFilter.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/EventFilter.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/EventFilter.java Wed Sep 7 09:49:37 2011
@@ -19,7 +19,7 @@ package org.apache.jackrabbit.spi;
import java.io.Serializable;
/**
- * An <code>EventFilter</code> is applied to the events as generated on the
+ * An {@code EventFilter} is applied to the events as generated on the
* repository server. Event filter instances can be created with {@link
* RepositoryService#createEventFilter(SessionInfo, int,
* Path, boolean, String[], Name[], boolean)}.
@@ -29,16 +29,16 @@ import java.io.Serializable;
public interface EventFilter extends Serializable {
/**
- * If an implementation returns <code>true</code> the <code>event</code>
+ * If an implementation returns {@code true} the {@code event}
* will be included in the event bundle returned by {@link
* RepositoryService#getEvents(Subscription, long)}. A return
- * value of <code>false</code> indicates that the client is not interested
- * in the <code>event</code>.
+ * value of {@code false} indicates that the client is not interested
+ * in the {@code event}.
*
* @param event the event in question.
* @param isLocal flag indicating whether this is a local event.
- * @return <code>true</code> if the event is accepted by the filter;
- * <code>false</code> otherwise.
+ * @return {@code true} if the event is accepted by the filter;
+ * {@code false} otherwise.
*/
boolean accept(Event event, boolean isLocal);
}
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/IdFactory.java Wed Sep 7 09:49:37 2011
@@ -17,61 +17,61 @@
package org.apache.jackrabbit.spi;
/**
- * <code>IdFactory</code> defines methods to construct new <code>ItemId</code>s.
- * This factory is intended to build <code>ItemId</code>s from the parameters
+ * {@code IdFactory} defines methods to construct new {@code ItemId}s.
+ * This factory is intended to build {@code ItemId}s from the parameters
* passed to the various create methods and should not make an attempt to
* apply additional logic such as e.g. roundtrips to the server or resolution of
- * <code>Path</code>s. Similarly the SPI implementation namely the
+ * {@code Path}s. Similarly the SPI implementation namely the
* {@link RepositoryService} must be able to deal with the various formats of
- * an <code>ItemId</code>, since a caller may not (yet) be aware of the uniqueID
+ * an {@code ItemId}, since a caller may not (yet) be aware of the uniqueID
* part of an ItemId.
*/
public interface IdFactory {
/**
- * Creates a new <code>PropertyId</code> from the given parent id and
+ * Creates a new {@code PropertyId} from the given parent id and
* property name.
*
* @param parentId
* @param propertyName
- * @return a new <code>PropertyId</code>.
+ * @return a new {@code PropertyId}.
*/
PropertyId createPropertyId(NodeId parentId, Name propertyName);
/**
- * Creates a new <code>NodeId</code> from the given parent id and
- * the given <code>Path</code> object.
+ * Creates a new {@code NodeId} from the given parent id and
+ * the given {@code Path} object.
*
* @param parentId
* @param path
- * @return a new <code>NodeId</code>.
+ * @return a new {@code NodeId}.
*/
NodeId createNodeId(NodeId parentId, Path path);
/**
- * Creates a new <code>NodeId</code> from the given unique id (which identifies
- * an ancestor <code>Node</code>) and the given <code>Path</code> object.
+ * Creates a new {@code NodeId} from the given unique id (which identifies
+ * an ancestor {@code Node}) and the given {@code Path} object.
*
* @param uniqueID
* @param path
- * @return a new <code>NodeId</code>.
+ * @return a new {@code NodeId}.
* @see ItemId ItemId for a description of the uniqueID defined by the SPI
* item identifiers.
*/
NodeId createNodeId(String uniqueID, Path path);
/**
- * Creates a new <code>NodeId</code> from the given unique id.
+ * Creates a new {@code NodeId} from the given unique id.
*
* @param uniqueID
- * @return a new <code>NodeId</code>.
+ * @return a new {@code NodeId}.
* @see ItemId ItemId for a description of the uniqueID defined by the SPI
* item identifiers.
*/
NodeId createNodeId(String uniqueID);
/**
- * Returns the JCR string representation of the given <code>nodeId</code>.
+ * Returns the JCR string representation of the given {@code nodeId}.
*
* @return a JCR node identifier string.
* @see #fromJcrIdentifier(String)
@@ -79,10 +79,10 @@ public interface IdFactory {
String toJcrIdentifier(NodeId nodeId);
/**
- * Create a new <code>NodeId</code> from the given JCR string representation.
+ * Create a new {@code NodeId} from the given JCR string representation.
*
* @param jcrIdentifier
- * @return a new <code>NodeId</code>.
+ * @return a new {@code NodeId}.
* @see #toJcrIdentifier(NodeId)
*/
NodeId fromJcrIdentifier(String jcrIdentifier);
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemId.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemId.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemId.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemId.java Wed Sep 7 09:49:37 2011
@@ -17,11 +17,11 @@
package org.apache.jackrabbit.spi;
/**
- * An <code>ItemId</code> identifies an item using a combination of unique ID
+ * An {@code ItemId} identifies an item using a combination of unique ID
* and path. There are three basic forms of an ItemId. The following
* table shows each of the allowed combinations where an <b>X</b> in
* the column indicates that a value is set and a <b>-</b> indicates
- * that the value is <code>null</code>:
+ * that the value is {@code null}:
* <table>
* <tr><th>UniqueID</th><th>Path</th><th>Usage</th></tr>
* <tr valign="top"><td align="center"><b>X</b></td><td align="center"><b>-</b></td>
@@ -40,31 +40,31 @@ package org.apache.jackrabbit.spi;
* can. {@link #getUniqueID} returns the unique ID of the nearest ancestor, which
* can be identified with a unique ID. The relative path provides a navigation
* path from the above mentioned ancestor to the item identified by the
- * <code>ItemId</code>.
+ * {@code ItemId}.
* </td></tr>
* </table>
* <p/>
- * Two <code>ItemId</code>s should be considered equal if both the unique part
+ * Two {@code ItemId}s should be considered equal if both the unique part
* and the path part are equal AND if they denote the same
- * {@link #denotesNode() type} of <code>ItemId</code>.
+ * {@link #denotesNode() type} of {@code ItemId}.
*/
public interface ItemId {
/**
- * @return <code>true</code> if this <code>ItemId</code> identifies a node;
- * otherwise <code>false</code>.
+ * @return {@code true} if this {@code ItemId} identifies a node;
+ * otherwise {@code false}.
*/
boolean denotesNode();
/**
- * @return the uniqueID part of this item id or <code>null</code> if the
+ * @return the uniqueID part of this item id or {@code null} if the
* identified item nor any of its ancestors can be identified with a
* uniqueID.
*/
String getUniqueID();
/**
- * @return the path part of this item id. Returns <code>null</code>
+ * @return the path part of this item id. Returns {@code null}
* if this item can be identified solely with a uniqueID.
*/
Path getPath();
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfo.java Wed Sep 7 09:49:37 2011
@@ -17,8 +17,8 @@
package org.apache.jackrabbit.spi;
/**
- * The <code>ItemInfo</code> is the base interface of <code>{@link NodeInfo}</code>
- * and <code>{@link PropertyInfo}</code>.
+ * The {@code ItemInfo} is the base interface of {@code }{@link NodeInfo}</code>
+ * and {@code }{@link PropertyInfo}</code>.
*/
public interface ItemInfo {
@@ -29,17 +29,17 @@ public interface ItemInfo {
ItemId getId();
/**
- * Returns true if this <code>ItemInfo</code> denotes a node, false otherwise.
+ * Returns true if this {@code ItemInfo} denotes a node, false otherwise.
*
- * @return true if this <code>ItemInfo</code> denotes a node, false otherwise.
+ * @return true if this {@code ItemInfo} denotes a node, false otherwise.
*/
boolean denotesNode();
/**
- * Returns the <code>Path</code> of the item represented by this
- * <code>ItemInfo</code>.
+ * Returns the {@code Path} of the item represented by this
+ * {@code ItemInfo}.
*
- * @return the <code>Path</code> of the item represented by this
+ * @return the {@code Path} of the item represented by this
* item info.
*/
Path getPath();
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java Wed Sep 7 09:49:37 2011
@@ -17,13 +17,13 @@
package org.apache.jackrabbit.spi;
/**
- * <code>ItemInfoCache</code> instances are responsible for caching
+ * {@code ItemInfoCache} instances are responsible for caching
* {@link ItemInfo}s along with an opaque generation counter. Implementations
* are free on the particular caching policy. That is, how long (if at all) item
* infos are cached.
*
- * An <code>ItemInfoCache</code> is supplied per session from the {@link RepositoryService}. It is used
- * to cache <code>ItemInfo</code>s read from the <code>RepositoryService</code>.
+ * An {@code ItemInfoCache} is supplied per session from the {@link RepositoryService}. It is used
+ * to cache {@code ItemInfo}s read from the {@code RepositoryService}.
*
* @see RepositoryService#getItemInfos(SessionInfo, ItemId)
*/
@@ -46,7 +46,7 @@ public interface ItemInfoCache {
public final long generation;
/**
- * Create a new cache entry containing <code>info</code> with a given <code>generation</code>.
+ * Create a new cache entry containing {@code info} with a given {@code generation}.
* @param info
* @param generation
*/
@@ -80,27 +80,27 @@ public interface ItemInfoCache {
}
/**
- * Retrieve a cache entry for the given <code>nodeId</code> or <code>null</code>
+ * Retrieve a cache entry for the given {@code nodeId} or {@code null}
* if no such entry is in the cache.
*
* @param nodeId id of the entry to lookup.
- * @return a <code>Entry<NodeInfo></code> instance or <code>null</code>
+ * @return a {@code Entry<NodeInfo>} instance or {@code null}
* if not found.
*/
ItemInfoCache.Entry<NodeInfo> getNodeInfo(NodeId nodeId);
/**
- * Retrieve a cache entry for the given <code>propertyId</code> or <code>null</code>
+ * Retrieve a cache entry for the given {@code propertyId} or {@code null}
* if no such entry is in the cache.
*
* @param propertyId id of the entry to lookup.
- * @return a <code>Entry<PropertyInfo></code> instance or
- * <code>null</code> if not found.
+ * @return a {@code Entry<PropertyInfo>} instance or
+ * {@code null} if not found.
*/
ItemInfoCache.Entry<PropertyInfo> getPropertyInfo(PropertyId propertyId);
/**
- * Create a {@link Entry} for <code>info</code> and <code>generation</code> and put it into
+ * Create a {@link Entry} for {@code info} and {@code generation} and put it into
* the cache.
* @param info
* @param generation
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/LockInfo.java Wed Sep 7 09:49:37 2011
@@ -17,7 +17,7 @@
package org.apache.jackrabbit.spi;
/**
- * <code>LockInfo</code> is used to transport lock information across the SPI
+ * {@code LockInfo} is used to transport lock information across the SPI
* boundary.
*
* @see RepositoryService#getLockInfo(SessionInfo, NodeId)
@@ -26,10 +26,10 @@ package org.apache.jackrabbit.spi;
public interface LockInfo {
/**
- * Returns the lock token for this lock or <code>null</code> if the token
+ * Returns the lock token for this lock or {@code null} if the token
* should not be exposed to the API user.
*
- * @return lock token or <code>null</code>
+ * @return lock token or {@code null}
* @see javax.jcr.lock.Lock#getLockToken()
*/
String getLockToken();
@@ -70,21 +70,21 @@ public interface LockInfo {
long getSecondsRemaining();
/**
- * Returns <code>true</code> if the <code>SessionInfo</code> used to
- * retrieve this <code>LockInfo</code> is the lock holder and thus enabled
+ * Returns {@code true} if the {@code SessionInfo} used to
+ * retrieve this {@code LockInfo} is the lock holder and thus enabled
* to refresh or release the lock.
*
- * @return <code>true</code> if the <code>SessionInfo</code> used to
- * retrieve this <code>LockInfo</code> is the lock holder.
+ * @return {@code true} if the {@code SessionInfo} used to
+ * retrieve this {@code LockInfo} is the lock holder.
* @see javax.jcr.lock.Lock#isLockOwningSession()
* @since JCR 2.0
*/
boolean isLockOwner();
/**
- * Returns the <code>NodeId</code> of the lock-holding Node.
+ * Returns the {@code NodeId} of the lock-holding Node.
*
- * @return the <code>NodeId</code> of the lock-holding Node.
+ * @return the {@code NodeId} of the lock-holding Node.
*/
NodeId getNodeId();
}
\ No newline at end of file
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Name.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Name.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Name.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Name.java Wed Sep 7 09:49:37 2011
@@ -19,20 +19,20 @@ package org.apache.jackrabbit.spi;
import java.io.Serializable;
/**
- * A <code>Name</code> is a combination of a namespace URI and a local part.
+ * A {@code Name} is a combination of a namespace URI and a local part.
* Instances of this class are used to internally represent the names of JCR
* content items and other objects within a content repository.
* <p/>
- * A <code>Name</code> is immutable once created.
+ * A {@code Name} is immutable once created.
* <p/>
- * The String representation of a <code>Name</code> object must be in the
- * format "<code>{namespaceURI}localPart</code>".
+ * The String representation of a {@code Name} object must be in the
+ * format "{@code }{namespaceURI}localPart</code>".
* <p/>
- * An implementation of the <code>Name</code> interface must implement the
+ * An implementation of the {@code Name} interface must implement the
* {@link Object#equals(Object)} method such that two Name objects are equal if
* both the namespace URI and the local part are equal.
*/
-public interface Name extends Comparable, Cloneable, Serializable {
+public interface Name extends Comparable<Name>, Cloneable, Serializable {
// default namespace (empty uri)
String NS_EMPTY_PREFIX = "";
@@ -65,19 +65,19 @@ public interface Name extends Comparable
String NS_XMLNS_URI = "http://www.w3.org/2000/xmlns/";
/**
- * Empty array of <code>Name</code>
+ * Empty array of {@code Name}
*/
Name[] EMPTY_ARRAY = new Name[0];
/**
- * Returns the local part of this <code>Name</code> object.
+ * Returns the local part of this {@code Name} object.
*
* @return local name
*/
String getLocalName();
/**
- * Returns the namespace URI of this <code>Name</code> object.
+ * Returns the namespace URI of this {@code Name} object.
*
* @return namespace URI
*/
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NameFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NameFactory.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NameFactory.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NameFactory.java Wed Sep 7 09:49:37 2011
@@ -17,33 +17,33 @@
package org.apache.jackrabbit.spi;
/**
- * <code>NameFactory</code>...
+ * {@code NameFactory}...
*/
public interface NameFactory {
/**
- * Returns a <code>Name</code> with the given namespace URI and
+ * Returns a {@code Name} with the given namespace URI and
* local part and validates the given parameters.
*
* @param namespaceURI namespace uri
* @param localName local part
- * @throws IllegalArgumentException if <code>namespaceURI</code> or
- * <code>localName</code> is invalid.
+ * @throws IllegalArgumentException if {@code namespaceURI} or
+ * {@code localName} is invalid.
*/
Name create(String namespaceURI, String localName) throws IllegalArgumentException;
/**
- * Returns a <code>Name</code> holding the value of the specified
+ * Returns a {@code Name} holding the value of the specified
* string. The string must be in the format returned by the
- * <code>Name.toString()</code> method, i.e.
+ * {@code Name.toString()} method, i.e.
* <p/>
- * <code><b>{</b>namespaceURI<b>}</b>localName</code>
+ * {@code <b>}{</b>namespaceURI<b>}</b>localName</code>
*
- * @param nameString a <code>String</code> containing the <code>Name</code>
+ * @param nameString a {@code String} containing the {@code Name}
* representation to be parsed.
- * @return the <code>Name</code> represented by the argument
+ * @return the {@code Name} represented by the argument
* @throws IllegalArgumentException if the specified string can not be parsed
- * as a <code>Name</code>.
+ * as a {@code Name}.
*/
Name create(String nameString) throws IllegalArgumentException;
}
\ No newline at end of file
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NodeId.java Wed Sep 7 09:49:37 2011
@@ -17,7 +17,7 @@
package org.apache.jackrabbit.spi;
/**
- * <code>NodeId</code> identifies a node on the SPI layer. The interface does
+ * {@code NodeId} identifies a node on the SPI layer. The interface does
* not add additional methods.
*/
public interface NodeId extends ItemId {
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/NodeInfo.java Wed Sep 7 09:49:37 2011
@@ -19,18 +19,18 @@ package org.apache.jackrabbit.spi;
import java.util.Iterator;
/**
- * The <code>NodeInfo</code> provides the basic information required to build
+ * The {@code NodeInfo} provides the basic information required to build
* nodes making up the repository hierarchy.<p/>
* Note however, that the list of child nodes does not form part of a
- * <code>NodeInfo</code>. It is retrieved by calling
+ * {@code NodeInfo}. It is retrieved by calling
* {@link RepositoryService#getChildInfos(SessionInfo, NodeId)}. In case of
* {@link RepositoryService#getItemInfos(SessionInfo, ItemId) batch read} the
- * child nodes might be part of the returned <code>Iterator</code>.
+ * child nodes might be part of the returned {@code Iterator}.
*/
public interface NodeInfo extends ItemInfo {
/**
- * Returns the <code>NodeId</code> for the node that is based on this info
+ * Returns the {@code NodeId} for the node that is based on this info
* object.
*
* @return identifier for the item that is based on this info object. the id
@@ -47,12 +47,12 @@ public interface NodeInfo extends ItemIn
int getIndex();
/**
- * @return <code>Name</code> representing the name of the primary nodetype.
+ * @return {@code Name} representing the name of the primary nodetype.
*/
Name getNodetype();
/**
- * @return Array of <code>Name</code>s representing the names of mixin nodetypes.
+ * @return Array of {@code Name}s representing the names of mixin nodetypes.
* This includes only explicitly assigned mixin nodetypes. It does not include
* mixin types inherited through the addition of supertypes to the primary
* type hierarchy. If there are no mixin node types assigned an empty
@@ -67,20 +67,20 @@ public interface NodeInfo extends ItemIn
Iterator<PropertyId> getPropertyIds();
/**
- * Return all <code>ChildInfo</code>s of the node represent by
+ * Return all {@code ChildInfo}s of the node represent by
* this info, an empty iterator if that node doesn't have any child nodes
- * or <code>null</code> if the implementation is not able or for some
- * internal reasons not willing to compute the <code>ChildInfo</code>
+ * or {@code null} if the implementation is not able or for some
+ * internal reasons not willing to compute the {@code ChildInfo}
* iterator. In the latter case the user of this API must call
* {@link RepositoryService#getChildInfos(SessionInfo, NodeId)} in order
* to determine the existence and identity of the child nodes.
*
- * @return An iterator of <code>ChildInfo</code>s or <code>null</code> if
+ * @return An iterator of {@code ChildInfo}s or {@code null} if
* the implementation is not able or willing to compute the set of
- * <code>ChildInfo</code>s (e.g. an implementation may choose to return
- * <code>null</code> if there is a huge amount of child nodes). In this
+ * {@code ChildInfo}s (e.g. an implementation may choose to return
+ * {@code null} if there is a huge amount of child nodes). In this
* case {@link RepositoryService#getChildInfos(SessionInfo, NodeId)} will
- * be used to load the <code>ChildInfo</code>s.
+ * be used to load the {@code ChildInfo}s.
*/
Iterator<ChildInfo> getChildInfos();
}
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Path.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Path.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Path.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Path.java Wed Sep 7 09:49:37 2011
@@ -21,7 +21,7 @@ import javax.jcr.RepositoryException;
import java.io.Serializable;
/**
- * The <code>Path</code> interface defines the SPI level representation of
+ * The {@code Path} interface defines the SPI level representation of
* a JCR path. It consists of an ordered list of {@link Path.Element} objects
* and is immutable.
* <p>
@@ -36,7 +36,7 @@ import java.io.Serializable;
* only occur as the first element in a path.</li>
* </ul>
* <p>
- * A <code>Path</code> is defined to have the following characteristics:
+ * A {@code Path} is defined to have the following characteristics:
* <p>
* <strong>Equality:</strong><br>
* Two paths are equal if they consist of the same elements.
@@ -126,11 +126,11 @@ public interface Path extends Serializab
char DELIMITER = '\t';
/**
- * Returns the name of the last path element, or <code>null</code>
+ * Returns the name of the last path element, or {@code null}
* for an identifier. The names of the special root, current and parent
* elements are "", "." and ".." in the default namespace.
*
- * @return name of the last path element, or <code>null</code>
+ * @return name of the last path element, or {@code null}
*/
Name getName();
@@ -157,38 +157,38 @@ public interface Path extends Serializab
* for non-identifier paths or identifier paths with other relative path
* elements.
*
- * @return identifier, or <code>null</code>
+ * @return identifier, or {@code null}
*/
String getIdentifier();
/**
* Tests whether this is the root path, i.e. "/".
*
- * @return <code>true</code> if this is the root path,
- * <code>false</code> otherwise.
+ * @return {@code true} if this is the root path,
+ * {@code false} otherwise.
*/
boolean denotesRoot();
/**
* Test if this path consists of a single identifier element.
*
- * @return <code>true</code> if this path is an identifier
+ * @return {@code true} if this path is an identifier
*/
boolean denotesIdentifier();
/**
* Checks if the last path element is the parent element ("..").
*
- * @return <code>true</code> if the last path element is the parent element,
- * <code>false</code> otherwise
+ * @return {@code true} if the last path element is the parent element,
+ * {@code false} otherwise
*/
boolean denotesParent();
/**
* Checks if the last path element is the current element (".").
*
- * @return <code>true</code> if the last path element is the current element,
- * <code>false</code> otherwise
+ * @return {@code true} if the last path element is the current element,
+ * {@code false} otherwise
*/
boolean denotesCurrent();
@@ -196,15 +196,15 @@ public interface Path extends Serializab
* Checks if the last path element is a named and optionally indexed
* element.
*
- * @return <code>true</code> if the last path element is a named element,
- * <code>false</code> otherwise
+ * @return {@code true} if the last path element is a named element,
+ * {@code false} otherwise
*/
boolean denotesName();
/**
* Test if this path represents an unresolved identifier-based path.
*
- * @return <code>true</code> if this path represents an unresolved
+ * @return {@code true} if this path represents an unresolved
* identifier-based path.
*/
boolean isIdentifierBased();
@@ -286,14 +286,14 @@ public interface Path extends Serializab
Path resolve(Path relative);
/**
- * Computes the relative path from <code>this</code> absolute path to
- * <code>other</code>.
+ * Computes the relative path from {@code this} absolute path to
+ * {@code other}.
*
* @param other an absolute path.
- * @return the relative path from <code>this</code> path to <code>other</code>
+ * @return the relative path from {@code this} path to {@code other}
* path.
- * @throws RepositoryException if either <code>this</code> or
- * <code>other</code> path is not absolute.
+ * @throws RepositoryException if either {@code this} or
+ * {@code other} path is not absolute.
*/
Path computeRelativePath(Path other) throws RepositoryException;
@@ -312,16 +312,16 @@ public interface Path extends Serializab
* </ul>
* <p/>
* If this path is relative the implementation may not be able to determine
- * if the ancestor at <code>degree</code> exists. Such an implementation
+ * if the ancestor at {@code degree} exists. Such an implementation
* should properly build the ancestor (i.e. parent of .. is ../..) and
- * leave if it the caller to throw <code>PathNotFoundException</code>.
+ * leave if it the caller to throw {@code PathNotFoundException}.
*
* @param degree the relative degree of the requested ancestor.
* @return the normalized ancestor path of the specified degree.
- * @throws IllegalArgumentException if <code>degree</code> is negative.
+ * @throws IllegalArgumentException if {@code degree} is negative.
* @throws PathNotFoundException if the implementation is able to determine
* that there is no ancestor of the specified degree. In case of this
- * being an absolute path, this would be the case if <code>degree</code> is
+ * being an absolute path, this would be the case if {@code degree} is
* greater that the {@link #getDepth() depth} of this path.
* @throws RepositoryException If the implementation is not able to determine
* the ancestor of the specified degree for some other reason.
@@ -330,7 +330,7 @@ public interface Path extends Serializab
/**
* Returns the number of ancestors of this path. This is the equivalent
- * of <code>{@link #getDepth()}</code> in case of a absolute path.
+ * of {@code }{@link #getDepth()}</code> in case of a absolute path.
* For relative path the number of ancestors cannot be determined and
* -1 should be returned.
*
@@ -350,7 +350,7 @@ public interface Path extends Serializab
* Also note that the special elements "." and ".." are not treated
* specially, e.g. both "/a/./.." and "/a/b/c" have a length of 4
* but this value does not necessarily reflect the true hierarchy level as
- * returned by <code>{@link #getDepth()}</code>.
+ * returned by {@code }{@link #getDepth()}</code>.
*
* @return the length of this path
* @see #getDepth()
@@ -375,12 +375,12 @@ public interface Path extends Serializab
int getDepth();
/**
- * Determines if the the <code>other</code> path would be equal to <code>this</code>
+ * Determines if the the {@code other} path would be equal to {@code this}
* path if both of them are normalized.
*
* @param other Another path.
* @return true if the given other path is equivalent to this path.
- * @throws IllegalArgumentException if the given path is <code>null</code>
+ * @throws IllegalArgumentException if the given path is {@code null}
* or if not both paths are either absolute or relative.
* @throws RepositoryException if any of the path cannot be normalized.
*/
@@ -389,13 +389,13 @@ public interface Path extends Serializab
/**
* Determines if <i>this</i> path is an ancestor of the specified path,
* based on their (absolute or relative) hierarchy level as returned by
- * <code>{@link #getDepth()}</code>. In case of undefined ancestor/descendant
+ * {@code }{@link #getDepth()}</code>. In case of undefined ancestor/descendant
* relationship that might occur with relative paths, the return value
- * should be <code>false</code>.
+ * should be {@code false}.
*
- * @return <code>true</code> if <code>other</code> is a descendant;
- * otherwise <code>false</code>.
- * @throws IllegalArgumentException if the given path is <code>null</code>
+ * @return {@code true} if {@code other} is a descendant;
+ * otherwise {@code false}.
+ * @throws IllegalArgumentException if the given path is {@code null}
* or if not both paths are either absolute or relative.
* @throws RepositoryException if any of the path cannot be normalized.
* @see #getDepth()
@@ -405,13 +405,13 @@ public interface Path extends Serializab
/**
* Determines if <i>this</i> path is a descendant of the specified path,
* based on their (absolute or relative) hierarchy level as returned by
- * <code>{@link #getDepth()}</code>. In case of undefined ancestor/descendant
+ * {@code }{@link #getDepth()}</code>. In case of undefined ancestor/descendant
* relationship that might occur with relative paths, the return value
- * should be <code>false</code>.
+ * should be {@code false}.
*
- * @return <code>true</code> if <code>other</code> is an ancestor;
- * otherwise <code>false</code>.
- * @throws IllegalArgumentException if the given path is <code>null</code>
+ * @return {@code true} if {@code other} is an ancestor;
+ * otherwise {@code false}.
+ * @throws IllegalArgumentException if the given path is {@code null}
* or if not both paths are either absolute or relative.
* @throws RepositoryException if any of the path cannot be normalized.
* @see #isAncestorOf(Path)
@@ -419,21 +419,21 @@ public interface Path extends Serializab
boolean isDescendantOf(Path other) throws IllegalArgumentException, RepositoryException;
/**
- * Returns a new <code>Path</code> consisting of those Path.Element objects
- * between the given <code>from</code>, inclusive, and the given <code>to</code>,
- * exclusive. An <code>IllegalArgumentException</code> is thrown if <code>from</code>
- * is greater or equal than <code>to</code> or if any of both params is
+ * Returns a new {@code Path} consisting of those Path.Element objects
+ * between the given {@code from}, inclusive, and the given {@code to},
+ * exclusive. An {@code IllegalArgumentException} is thrown if {@code from}
+ * is greater or equal than {@code to} or if any of both params is
* out of the possible range.
*
* @param from index of the element to start with and low endpoint
* (inclusive) within the list of elements to use for the sub-path.
* @param to index of the element outside of the range i.e. high endpoint
* (exclusive) within the list of elements to use for the sub-path.
- * @return a new <code>Path</code> consisting of those Path.Element objects
- * between the given <tt><code>from</code>, inclusive, and the given
- * <code>to</code>, exclusive.
- * @throws IllegalArgumentException if <code>from</code>
- * is greater or equal than <code>to</code> or if any of both params is
+ * @return a new {@code Path} consisting of those Path.Element objects
+ * between the given <tt>{@code from}, inclusive, and the given
+ * {@code to}, exclusive.
+ * @throws IllegalArgumentException if {@code from}
+ * is greater or equal than {@code to} or if any of both params is
* out of the possible range.
*/
Path subPath(int from, int to) throws IllegalArgumentException;
@@ -462,10 +462,10 @@ public interface Path extends Serializab
/**
* Returns a path that consists of all but the last element of this path.
- * Returns <code>null</code> if this path contains just a single element.
+ * Returns {@code null} if this path contains just a single element.
*
* @see #getLastElement()
- * @return first elements of this path, or <code>null</code>
+ * @return first elements of this path, or {@code null}
*/
Path getFirstElements();
@@ -482,19 +482,19 @@ public interface Path extends Serializab
//----------------------------------------------------< inner interface >---
/**
- * Object representation of a single JCR path element. An <code>Element</code>
- * object contains the <code>Name</code> and optional index of a single
+ * Object representation of a single JCR path element. An {@code Element}
+ * object contains the {@code Name} and optional index of a single
* JCR path element.
* <p/>
- * Once created, a <code>Element</code> object must be immutable.
+ * Once created, a {@code Element} object must be immutable.
* <p/>
- * The String presentation of an <code>Element</code> must be in the format
- * "<code>{namespaceURI}localPart</code>" or
- * "<code>{namespaceURI}localPart[index]</code>" case of an index greater
+ * The String presentation of an {@code Element} must be in the format
+ * "{@code }{namespaceURI}localPart</code>" or
+ * "{@code }{namespaceURI}localPart[index]</code>" case of an index greater
* than {@link Path#INDEX_DEFAULT}.
* <p/>
* Note, that the implementation must implement the equals method such, that
- * two <code>Element</code> objects having equals <code>Name</code>s and the
+ * two {@code Element} objects having equals {@code Name}s and the
* same normalized index must be equal.
*/
interface Element extends Serializable {
@@ -523,60 +523,60 @@ public interface Path extends Serializab
/**
* Returns the identifier of an identifier element, or
- * <code>null</code> for other kinds of elements.
+ * {@code null} for other kinds of elements.
*
- * @return identifier, or <code>null</code>
+ * @return identifier, or {@code null}
*/
String getIdentifier();
/**
- * Returns <code>true</code> if this element denotes the <i>root</i> element,
- * otherwise returns <code>false</code>.
+ * Returns {@code true} if this element denotes the <i>root</i> element,
+ * otherwise returns {@code false}.
*
- * @return <code>true</code> if this element denotes the <i>root</i>
- * element; otherwise <code>false</code>
+ * @return {@code true} if this element denotes the <i>root</i>
+ * element; otherwise {@code false}
*/
boolean denotesRoot();
/**
- * Returns <code>true</code> if this element denotes the <i>parent</i>
- * ('..') element, otherwise returns <code>false</code>.
+ * Returns {@code true} if this element denotes the <i>parent</i>
+ * ('..') element, otherwise returns {@code false}.
*
- * @return <code>true</code> if this element denotes the <i>parent</i>
- * element; otherwise <code>false</code>
+ * @return {@code true} if this element denotes the <i>parent</i>
+ * element; otherwise {@code false}
*/
boolean denotesParent();
/**
- * Returns <code>true</code> if this element denotes the <i>current</i>
- * ('.') element, otherwise returns <code>false</code>.
+ * Returns {@code true} if this element denotes the <i>current</i>
+ * ('.') element, otherwise returns {@code false}.
*
- * @return <code>true</code> if this element denotes the <i>current</i>
- * element; otherwise <code>false</code>
+ * @return {@code true} if this element denotes the <i>current</i>
+ * element; otherwise {@code false}
*/
boolean denotesCurrent();
/**
- * Returns <code>true</code> if this element represents a regular name
- * (i.e. neither root, '.' nor '..'), otherwise returns <code>false</code>.
+ * Returns {@code true} if this element represents a regular name
+ * (i.e. neither root, '.' nor '..'), otherwise returns {@code false}.
*
- * @return <code>true</code> if this element represents a regular name;
- * otherwise <code>false</code>
+ * @return {@code true} if this element represents a regular name;
+ * otherwise {@code false}
*/
boolean denotesName();
/**
- * Returns <code>true</code> if this element represents an identifier element.
- *
- * @return <code>true</code> if this element represents an identifier element.
+ * Returns {@code true} if this element represents an identifier element.
+ *
+ * @return {@code true} if this element represents an identifier element.
* @since JCR 2.0
*/
boolean denotesIdentifier();
/**
* Return the String presentation of a {@link Path.Element}. It must be
- * in the format "<code>{namespaceURI}localPart</code>" or
- * "<code>{namespaceURI}localPart[index]</code>" in case of an index
+ * in the format "{@code }{namespaceURI}localPart</code>" or
+ * "{@code }{namespaceURI}localPart[index]</code>" in case of an index
* greater than {@link Path#INDEX_DEFAULT}.
*
* @return String representation of a {@link Path.Element}.
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PathFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PathFactory.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PathFactory.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PathFactory.java Wed Sep 7 09:49:37 2011
@@ -19,44 +19,44 @@ package org.apache.jackrabbit.spi;
import javax.jcr.RepositoryException;
/**
- * <code>PathFactory</code>...
+ * {@code PathFactory}...
*/
public interface PathFactory {
/**
- * Return a new <code>Path</code> out of the given <code>parent<code> path
- * and the given relative path. If <code>normalize</code> is
- * <code>true</code>, the returned path will be normalized (or
+ * Return a new {@code Path} out of the given {@code parent<code> path}
+ * and the given relative path. If {@code normalize} is
+ * {@code true}, the returned path will be normalized (or
* canonicalized, if the parent path is absolute).
*
* @param parent
* @param relPath
* @param normalize
* @return
- * @throws IllegalArgumentException if <code>relPath</code> is absolute.
- * @throws RepositoryException If the <code>normalized</code> is
- * <code>true</code> and the resulting path cannot be normalized.
+ * @throws IllegalArgumentException if {@code relPath} is absolute.
+ * @throws RepositoryException If the {@code normalized} is
+ * {@code true} and the resulting path cannot be normalized.
*/
Path create(Path parent, Path relPath, boolean normalize) throws IllegalArgumentException, RepositoryException;
/**
- * Creates a new <code>Path</code> out of the given <code>parent</code> path
- * and the give name. If <code>normalize</code> is <code>true</code>,
+ * Creates a new {@code Path} out of the given {@code parent} path
+ * and the give name. If {@code normalize} is {@code true},
* the returned path will be normalized (or canonicalized, if the parent
* path is absolute). Use {@link PathFactory#create(Path, Name, int, boolean)}
- * in order to build a <code>Path</code> having an index with his name element.
+ * in order to build a {@code Path} having an index with his name element.
*
* @param parent the parent path
* @param name the name of the new path element.
* @param normalize If true the Path is normalized before being returned.
* @return
- * @throws RepositoryException If the <code>normalized</code> is
- * <code>true</code> and the resulting path cannot be normalized.
+ * @throws RepositoryException If the {@code normalized} is
+ * {@code true} and the resulting path cannot be normalized.
*/
Path create(Path parent, Name name, boolean normalize) throws RepositoryException;
/**
- * Creates a new <code>Path</code> out of the given <code>parent<code> path
+ * Creates a new {@code Path} out of the given {@code parent<code> path}
* and the give name and normalized index. See also
* {@link PathFactory#create(Path, Name, boolean)}.
*
@@ -67,8 +67,8 @@ public interface PathFactory {
* @return
* @throws IllegalArgumentException If the given index is lower than
* {@link Path#INDEX_UNDEFINED}.
- * @throws RepositoryException If the <code>normalized</code> is
- * <code>true</code> and the resulting path cannot be normalized.
+ * @throws RepositoryException If the {@code normalized} is
+ * {@code true} and the resulting path cannot be normalized.
*/
Path create(Path parent, Name name, int index, boolean normalize) throws IllegalArgumentException, RepositoryException;
@@ -76,8 +76,8 @@ public interface PathFactory {
* Creates a relative path based on a {@link Name}.
*
* @param name single {@link Name} for this relative path.
- * @return the relative path created from <code>name</code>.
- * @throws IllegalArgumentException if the name is <code>null</code>.
+ * @return the relative path created from {@code name}.
+ * @throws IllegalArgumentException if the name is {@code null}.
*/
Path create(Name name) throws IllegalArgumentException;
@@ -88,8 +88,8 @@ public interface PathFactory {
*
* @param name single {@link Name} for this relative path.
* @param index index of the single name element.
- * @return the relative path created from <code>name</code> and <code>normalizedIndex</code>.
- * @throws IllegalArgumentException if <code>index</code> is lower
+ * @return the relative path created from {@code name} and {@code normalizedIndex}.
+ * @throws IllegalArgumentException if {@code index} is lower
* than {@link Path#INDEX_UNDEFINED} or if the name is not valid.
*/
Path create(Name name, int index) throws IllegalArgumentException;
@@ -99,37 +99,37 @@ public interface PathFactory {
*
* @param element path element
* @return the created path
- * @throws IllegalArgumentException if the given element is <code>null</code>
+ * @throws IllegalArgumentException if the given element is {@code null}
*/
Path create(Path.Element element) throws IllegalArgumentException;
/**
- * Create a new <code>Path</code> from the given elements.
+ * Create a new {@code Path} from the given elements.
*
* @param elements
- * @return the <code>Path</code> created from the elements.
- * @throws IllegalArgumentException If the given elements are <code>null</code>
+ * @return the {@code Path} created from the elements.
+ * @throws IllegalArgumentException If the given elements are {@code null}
* or have a length of 0 or would otherwise constitute an invalid path.
*/
Path create(Path.Element[] elements) throws IllegalArgumentException;
/**
- * Returns a <code>Path</code> holding the value of the specified
+ * Returns a {@code Path} holding the value of the specified
* string. The string must be in the format returned by the
- * <code>Path.getString()</code> method.
+ * {@code Path.getString()} method.
*
- * @param pathString a <code>String</code> containing the <code>Path</code>
+ * @param pathString a {@code String} containing the {@code Path}
* representation to be parsed.
- * @return the <code>Path</code> represented by the argument
+ * @return the {@code Path} represented by the argument
* @throws IllegalArgumentException if the specified string can not be parsed
- * as a <code>Path</code>.
+ * as a {@code Path}.
* @see Path#getString()
* @see Path#DELIMITER
*/
Path create(String pathString) throws IllegalArgumentException;
/**
- * Creates a path element from the given <code>name</code>.
+ * Creates a path element from the given {@code name}.
* The created path element does not contain an explicit index.
* <p/>
* If the specified name denotes a <i>special</i> path element (either
@@ -138,7 +138,7 @@ public interface PathFactory {
*
* @param name the name of the element
* @return a path element
- * @throws IllegalArgumentException if the name is <code>null</code>
+ * @throws IllegalArgumentException if the name is {@code null}
*/
Path.Element createElement(Name name) throws IllegalArgumentException;
@@ -155,18 +155,18 @@ public interface PathFactory {
* @param name the name of the element
* @param index the index if the element.
* @return a path element
- * @throws IllegalArgumentException if the name is <code>null</code>,
+ * @throws IllegalArgumentException if the name is {@code null},
* if the given index is lower than {@link Path#INDEX_UNDEFINED} or if name
* denoting a special path element.
*/
Path.Element createElement(Name name, int index) throws IllegalArgumentException;
/**
- * Creates a path element from the given <code>identifier</code>.
+ * Creates a path element from the given {@code identifier}.
*
* @param identifier Node identifier for which the path element should be created.
* @return a path element.
- * @throws IllegalArgumentException If the <code>identifier</code> is <code>null</code>.
+ * @throws IllegalArgumentException If the {@code identifier} is {@code null}.
* @since JCR 2.0
*/
Path.Element createElement(String identifier) throws IllegalArgumentException;
@@ -193,9 +193,9 @@ public interface PathFactory {
Path.Element getRootElement();
/**
- * Return the <code>Path</code> of the root node.
+ * Return the {@code Path} of the root node.
*
- * @return the <code>Path</code> of the root node.
+ * @return the {@code Path} of the root node.
*/
Path getRootPath();
}
\ No newline at end of file
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PrivilegeDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PrivilegeDefinition.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PrivilegeDefinition.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PrivilegeDefinition.java Wed Sep 7 09:49:37 2011
@@ -19,7 +19,7 @@ package org.apache.jackrabbit.spi;
import java.util.Set;
/**
- * <code>PrivilegeDefinition</code>...
+ * {@code PrivilegeDefinition}...
*/
public interface PrivilegeDefinition {
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PropertyId.java Wed Sep 7 09:49:37 2011
@@ -17,21 +17,21 @@
package org.apache.jackrabbit.spi;
/**
- * <code>PropertyId</code> identifies a property on the SPI layer.
+ * {@code PropertyId} identifies a property on the SPI layer.
*/
public interface PropertyId extends ItemId {
/**
- * Returns the <code>NodeId</code> of the parent.
+ * Returns the {@code NodeId} of the parent.
*
- * @return The {@link NodeId parentId} of this <code>PropertyId</code>.
+ * @return The {@link NodeId parentId} of this {@code PropertyId}.
*/
NodeId getParentId();
/**
* Returns the {@link Name} of the property identified by this id.
*
- * @return The name of the property that is identified by this <code>PropertyId</code>.
+ * @return The name of the property that is identified by this {@code PropertyId}.
*/
Name getName();
}
\ No newline at end of file
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PropertyInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PropertyInfo.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PropertyInfo.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/PropertyInfo.java Wed Sep 7 09:49:37 2011
@@ -17,8 +17,8 @@
package org.apache.jackrabbit.spi;
/**
- * The <code>PropertyInfo</code> provides the basic information to build a
- * <code>Property</code>. The definition must be calculated from the parent
+ * The {@code PropertyInfo} provides the basic information to build a
+ * {@code Property}. The definition must be calculated from the parent
* node type or retrieved from the RepositoryService.
*/
public interface PropertyInfo extends ItemInfo {
@@ -31,23 +31,23 @@ public interface PropertyInfo extends It
PropertyId getId();
/**
- * @return The {@link javax.jcr.PropertyType type} of the <code>Property</code>
- * base on this <code>PropertyInfo</code>. Note, that
+ * @return The {@link javax.jcr.PropertyType type} of the {@code Property}
+ * base on this {@code PropertyInfo}. Note, that
* {@link javax.jcr.PropertyType#UNDEFINED} will never be returned as the
- * value of a <code>Property</code> always has a defined type.
+ * value of a {@code Property} always has a defined type.
* @see javax.jcr.PropertyType
*/
int getType();
/**
- * @return true if the <code>Property</code> based on this info object is
+ * @return true if the {@code Property} based on this info object is
* multivalue.
* @see javax.jcr.nodetype.PropertyDefinition#isMultiple()
*/
boolean isMultiValued();
/**
- * @return The values present on this <code>PropertyInfo</code>.
+ * @return The values present on this {@code PropertyInfo}.
*/
QValue[] getValues();
}
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QItemDefinition.java Wed Sep 7 09:49:37 2011
@@ -19,8 +19,8 @@ package org.apache.jackrabbit.spi;
import javax.jcr.nodetype.ItemDefinition;
/**
- * <code>QItemDefinition</code> is the SPI representation of
- * an {@link ItemDefinition item definition}. It refers to <code>Name</code>s
+ * {@code QItemDefinition} is the SPI representation of
+ * an {@link ItemDefinition item definition}. It refers to {@code Name}s
* only and is thus isolated from session-specific namespace mappings.
*
* @see javax.jcr.nodetype.ItemDefinition
@@ -28,7 +28,7 @@ import javax.jcr.nodetype.ItemDefinition
public interface QItemDefinition {
/**
- * Empty array of <code>QItemDefinition</code>.
+ * Empty array of {@code QItemDefinition}.
*/
QItemDefinition[] EMPTY_ARRAY = new QItemDefinition[0];
@@ -78,16 +78,16 @@ public interface QItemDefinition {
* Determines whether this item definition defines a residual set of
* child items.
*
- * @return <code>true</code> if this definition defines a residual set;
- * <code>false</code> otherwise.
+ * @return {@code true} if this definition defines a residual set;
+ * {@code false} otherwise.
*/
boolean definesResidual();
/**
* Determines whether this item definition defines a node.
*
- * @return <code>true</code> if this is a node definition;
- * <code>false</code> otherwise (i.e. it is a property definition).
+ * @return {@code true} if this is a node definition;
+ * {@code false} otherwise (i.e. it is a property definition).
*/
boolean definesNode();
}
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QNodeDefinition.java Wed Sep 7 09:49:37 2011
@@ -19,8 +19,8 @@ package org.apache.jackrabbit.spi;
import javax.jcr.nodetype.NodeDefinition;
/**
- * <code>QNodeDefinition</code> is the SPI representation of
- * a {@link NodeDefinition node definition}. It refers to <code>Name</code>s only
+ * {@code QNodeDefinition} is the SPI representation of
+ * a {@link NodeDefinition node definition}. It refers to {@code Name}s only
* and is thus isolated from session-specific namespace mappings.
*
* @see javax.jcr.nodetype.NodeDefinition
@@ -28,7 +28,7 @@ import javax.jcr.nodetype.NodeDefinition
public interface QNodeDefinition extends QItemDefinition {
/**
- * Empty array of <code>QNodeDefinition</code>.
+ * Empty array of {@code QNodeDefinition}.
*/
QNodeDefinition[] EMPTY_ARRAY = new QNodeDefinition[0];
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QNodeTypeDefinition.java Wed Sep 7 09:49:37 2011
@@ -19,8 +19,8 @@ package org.apache.jackrabbit.spi;
import java.util.Collection;
/**
- * <code>QNodeTypeDefinition</code> is the SPI representation of a
- * {@link javax.jcr.nodetype.NodeType node type}. It refers to <code>Name</code>s
+ * {@code QNodeTypeDefinition} is the SPI representation of a
+ * {@link javax.jcr.nodetype.NodeType node type}. It refers to {@code Name}s
* only and is therefore independent of session-specific namespace mappings.
*
* @see javax.jcr.nodetype.NodeType
@@ -29,17 +29,17 @@ public interface QNodeTypeDefinition {
/**
* Returns the name of the node type being defined or
- * <code>null</code> if not set.
+ * {@code null} if not set.
*
- * @return the name of the node type or <code>null</code> if not set.
+ * @return the name of the node type or {@code null} if not set.
*/
Name getName();
/**
* Returns an array containing the names of the supertypes. If no
* supertypes have been specified, then an empty array is returned
- * for mixin types and the <code>nt:base</code> primary type and
- * an array containing just <code>nt:base<code> for other primary types.
+ * for mixin types and the {@code nt:base} primary type and
+ * an array containing just {@code nt:base{@code for other primary types.}}
* <p>
* The returned array must not be modified by the application.
*
@@ -53,7 +53,7 @@ public interface QNodeTypeDefinition {
* <p>
* The returned array must not be modified by the application.
*
- * @return an array of mixin type names, or <code>null</code>
+ * @return an array of mixin type names, or {@code null}
* when there are no known constraints.
*/
Name[] getSupportedMixinTypes();
@@ -66,17 +66,17 @@ public interface QNodeTypeDefinition {
boolean isMixin();
/**
- * Returns <code>true</code> if the definition is abstract; <code>false</code> otherwise.
+ * Returns {@code true} if the definition is abstract; {@code false} otherwise.
*
- * @return <code>true</code> if the definition is abstract; <code>false</code> otherwise.
+ * @return {@code true} if the definition is abstract; {@code false} otherwise.
* @since JCR 2.0
*/
boolean isAbstract();
/**
- * Returns <code>true</code> if the definition is queryable; <code>false</code> otherwise.
+ * Returns {@code true} if the definition is queryable; {@code false} otherwise.
*
- * @return <code>true</code> if the definition is queryable; <code>false</code> otherwise.
+ * @return {@code true} if the definition is queryable; {@code false} otherwise.
* @since JCR 2.0
*/
boolean isQueryable();
@@ -90,9 +90,9 @@ public interface QNodeTypeDefinition {
/**
* Returns the name of the primary item (one of the child items of the
- * node's of this node type) or <code>null</code> if not set.
+ * node's of this node type) or {@code null} if not set.
*
- * @return the name of the primary item or <code>null</code> if not set.
+ * @return the name of the primary item or {@code null} if not set.
*/
Name getPrimaryItemName();
@@ -111,7 +111,7 @@ public interface QNodeTypeDefinition {
QNodeDefinition[] getChildNodeDefs();
/**
- * Returns a collection of node type <code>Name</code>s that are being
+ * Returns a collection of node type {@code Name}s that are being
* referenced by <i>this</i> node type definition (e.g. as supertypes, as
* required/default primary types in child node definitions, as REFERENCE
* value constraints in property definitions).
@@ -120,7 +120,7 @@ public interface QNodeTypeDefinition {
* the declaring node type as the default primary type) are not considered
* dependencies.
*
- * @return a collection of node type <code>Name</code>s
+ * @return a collection of node type {@code Name}s
*/
Collection<Name> getDependencies();
}
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QPropertyDefinition.java Wed Sep 7 09:49:37 2011
@@ -19,8 +19,8 @@ package org.apache.jackrabbit.spi;
import javax.jcr.nodetype.PropertyDefinition;
/**
- * <code>QPropertyDefinition</code> is the SPI representation of
- * a {@link PropertyDefinition property definition}. It refers to <code>Name</code>s,
+ * {@code QPropertyDefinition} is the SPI representation of
+ * a {@link PropertyDefinition property definition}. It refers to {@code Name}s,
* SPI default values and value constraints only and is thus isolated
* from session-specific namespace mappings.
*
@@ -29,7 +29,7 @@ import javax.jcr.nodetype.PropertyDefini
public interface QPropertyDefinition extends QItemDefinition {
/**
- * Empty array of <code>QPropertyDefinition</code>.
+ * Empty array of {@code QPropertyDefinition}.
*/
QPropertyDefinition[] EMPTY_ARRAY = new QPropertyDefinition[0];
@@ -48,10 +48,10 @@ public interface QPropertyDefinition ext
QValueConstraint[] getValueConstraints();
/**
- * Returns the array of default values or <code>null</code> if no default
+ * Returns the array of default values or {@code null} if no default
* values are defined.
*
- * @return the array of default values or <code>null</code>
+ * @return the array of default values or {@code null}
*/
QValue[] getDefaultValues();
@@ -73,7 +73,7 @@ public interface QPropertyDefinition ext
/**
* Reports whether this property definition is full text searchable.
*
- * @return <code>true</code> if this property definition is full text searchable.
+ * @return {@code true} if this property definition is full text searchable.
* @since JCR 2.0
*/
boolean isFullTextSearchable();
@@ -81,7 +81,7 @@ public interface QPropertyDefinition ext
/**
* Reports whether this property definition is query-orderable.
*
- * @return <code>true</code> if this property definition is query-orderable.
+ * @return {@code true} if this property definition is query-orderable.
* @since JCR 2.0
*/
boolean isQueryOrderable();
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValue.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValue.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValue.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValue.java Wed Sep 7 09:49:37 2011
@@ -27,9 +27,9 @@ import javax.jcr.RepositoryException;
import javax.jcr.Binary;
/**
- * <code>QValue</code> is the SPI representation of a
- * {@link javax.jcr.Value jcr value}. It therefore refers to <code>Name</code>s
- * and <code>Path</code>s only and is thus isolated from session-specific
+ * {@code QValue} is the SPI representation of a
+ * {@link javax.jcr.Value jcr value}. It therefore refers to {@code Name}s
+ * and {@code Path}s only and is thus isolated from session-specific
* namespace mappings.
*/
public interface QValue {
@@ -37,7 +37,7 @@ public interface QValue {
QValue[] EMPTY_ARRAY = new QValue[0];
/**
- * Returns the <code>PropertyType</code> of this <code>QValue</code> object.
+ * Returns the {@code PropertyType} of this {@code QValue} object.
* It may be either of the value property types defined by the JSR 283:
* <ul>
* <li>{@link PropertyType#STRING}</li>
@@ -54,7 +54,7 @@ public interface QValue {
* <li>{@link PropertyType#WEAKREFERENCE}</li>
* </ul>
*
- * @return the <code>PropertyType</code> of this <code>QValue</code> object.
+ * @return the {@code PropertyType} of this {@code QValue} object.
*/
int getType();
@@ -66,23 +66,23 @@ public interface QValue {
* of a property such as retrieved by calling {@link Property#getLength()}
* and {@link Property#getLengths()}.
*
- * @return length of this <code>QValue</code> object.
+ * @return length of this {@code QValue} object.
* @throws RepositoryException
*/
long getLength() throws RepositoryException;
/**
- * Returns a <code>String</code> representation of this <code>QValue</code>
+ * Returns a {@code String} representation of this {@code QValue}
* object.
*
- * @return A <code>String</code> representation of this <code>QValue</code>
+ * @return A {@code String} representation of this {@code QValue}
* object.
* @throws RepositoryException
*/
String getString() throws RepositoryException;
/**
- * Returns an <code>InputStream</code> representation of this <code>QValue</code>
+ * Returns an {@code InputStream} representation of this {@code QValue}
* object. This method always returns a new stream.
*
* @return A stream representation of this value.
@@ -91,75 +91,75 @@ public interface QValue {
InputStream getStream() throws RepositoryException;
/**
- * Returns a <code>Binary</code> representation of this <code>QValue</code>
+ * Returns a {@code Binary} representation of this {@code QValue}
* object.
*
- * @return A <code>Binary</code> representation of this value.
+ * @return A {@code Binary} representation of this value.
* @throws RepositoryException
*/
Binary getBinary() throws RepositoryException;
/**
- * Returns a <code>Calendar</code> representation of this value.
+ * Returns a {@code Calendar} representation of this value.
*
- * @return A <code>Calendar</code> representation of this value.
+ * @return A {@code Calendar} representation of this value.
* @throws RepositoryException if an error occurs.
*/
Calendar getCalendar() throws RepositoryException;
/**
- * Returns a <code>BigDecimal</code> representation of this value.
+ * Returns a {@code BigDecimal} representation of this value.
*
- * @return A <code>BigDecimal</code> representation of this value.
+ * @return A {@code BigDecimal} representation of this value.
* @throws RepositoryException if an error occurs.
*/
BigDecimal getDecimal() throws RepositoryException;
/**
- * Returns a <code>double</code> representation of this value.
+ * Returns a {@code double} representation of this value.
*
- * @return A <code>double</code> representation of this value.
+ * @return A {@code double} representation of this value.
* @throws RepositoryException if an error occurs.
*/
double getDouble() throws RepositoryException;
/**
- * Returns a <code>long</code> representation of this value.
+ * Returns a {@code long} representation of this value.
*
- * @return A <code>long</code> representation of this value.
+ * @return A {@code long} representation of this value.
* @throws RepositoryException if an error occurs.
*/
long getLong() throws RepositoryException;
/**
- * Returns a <code>boolean</code> representation of this value.
+ * Returns a {@code boolean} representation of this value.
*
- * @return A <code>boolean</code> representation of this value.
+ * @return A {@code boolean} representation of this value.
* @throws RepositoryException if an error occurs.
*/
boolean getBoolean() throws RepositoryException;
/**
- * Returns a <code>Name</code> representation of this value.
+ * Returns a {@code Name} representation of this value.
*
- * @return A <code>Name</code> representation of this value.
+ * @return A {@code Name} representation of this value.
* @throws RepositoryException if an error occurs.
*/
Name getName() throws RepositoryException;
/**
- * Returns a <code>Path</code> representation of this value.
+ * Returns a {@code Path} representation of this value.
*
- * @return A <code>Path</code> representation of this value.
+ * @return A {@code Path} representation of this value.
* @throws RepositoryException if an error occurs.
*/
Path getPath() throws RepositoryException;
/**
- * Returns an <code>URI</code> representation of this value.
+ * Returns an {@code URI} representation of this value.
*
- * @return A <code>URI</code> representation of this value.
+ * @return A {@code URI} representation of this value.
* @throws RepositoryException if an error occurs.
*/
URI getURI() throws RepositoryException;
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValueConstraint.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValueConstraint.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValueConstraint.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValueConstraint.java Wed Sep 7 09:49:37 2011
@@ -21,7 +21,7 @@ import javax.jcr.nodetype.PropertyDefini
import javax.jcr.RepositoryException;
/**
- * <code>QValueConstraint</code> is used to check the syntax of a value
+ * {@code QValueConstraint} is used to check the syntax of a value
* constraint and to test if a specific value satisfies it.
*
* @see PropertyDefinition#getValueConstraints()
@@ -29,7 +29,7 @@ import javax.jcr.RepositoryException;
public interface QValueConstraint {
/**
- * Empty array of <code>QValueConstraint</code>.
+ * Empty array of {@code QValueConstraint}.
*/
QValueConstraint[] EMPTY_ARRAY = new QValueConstraint[0];
@@ -38,7 +38,7 @@ public interface QValueConstraint {
*
* @param value The value to be tested.
* @throws ConstraintViolationException If the specified value is
- * <code>null</code> or does not matches the constraint.
+ * {@code null} or does not matches the constraint.
* @throws RepositoryException If another error occurs.
*/
void check(QValue value) throws ConstraintViolationException, RepositoryException;
@@ -46,11 +46,11 @@ public interface QValueConstraint {
/**
* For constraints that are not namespace prefix mapping sensitive this
* method returns the same defined in
- * <code>{@link PropertyDefinition#getValueConstraints()}</code>.
+ * {@code }{@link PropertyDefinition#getValueConstraints()}</code>.
* <p/>
* Those that are namespace prefix mapping sensitive (e.g.
- * <code>NameConstraint</code>, <code>PathConstraint</code> and
- * <code>ReferenceConstraint</code>) return an internal string.
+ * {@code NameConstraint}, {@code PathConstraint} and
+ * {@code ReferenceConstraint}) return an internal string.
*
* @return the internal definition String
*/
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValueFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValueFactory.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValueFactory.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QValueFactory.java Wed Sep 7 09:49:37 2011
@@ -27,99 +27,99 @@ import javax.jcr.RepositoryException;
import javax.jcr.ValueFormatException;
/**
- * <code>QValueFactory</code> defines methods to create <code>QValue</code>
+ * {@code QValueFactory} defines methods to create {@code QValue}
* instances.
*/
public interface QValueFactory {
/**
- * Create a new <code>QValue</code> using the given String representation
+ * Create a new {@code QValue} using the given String representation
* of the value and its {@link javax.jcr.PropertyType type}.
*
- * @param value String representation of the new <code>QValue</code>. Note,
- * that the given String must never be <code>null</code>.
+ * @param value String representation of the new {@code QValue}. Note,
+ * that the given String must never be {@code null}.
* @param type A valid {@link javax.jcr.PropertyType type}.
- * @return a new <code>QValue</code>.
- * @throws ValueFormatException If the given <code>value</code> cannot be
- * converted to the specified <code>type</code>.
+ * @return a new {@code QValue}.
+ * @throws ValueFormatException If the given {@code value} cannot be
+ * converted to the specified {@code type}.
* @throws RepositoryException If another error occurs.
* @see QValue#getType()
*/
QValue create(String value, int type) throws ValueFormatException, RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#DATE}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#DATE}.
*
- * @param value A non-null <code>Calendar</code> object acting as value
- * of the new <code>QValue</code>.
- * @return a new <code>QValue</code>.
+ * @param value A non-null {@code Calendar} object acting as value
+ * of the new {@code QValue}.
+ * @return a new {@code QValue}.
*/
QValue create(Calendar value) throws RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#DOUBLE}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#DOUBLE}.
*
- * @param value A <code>double</code> containing the value
- * of the new <code>QValue</code>.
- * @return a new <code>QValue</code>.
+ * @param value A {@code double} containing the value
+ * of the new {@code QValue}.
+ * @return a new {@code QValue}.
*/
QValue create(double value) throws RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#LONG}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#LONG}.
*
- * @param value A <code>long</code> containing the value
- * of the new <code>QValue</code>.
- * @return a new <code>QValue</code>.
+ * @param value A {@code long} containing the value
+ * of the new {@code QValue}.
+ * @return a new {@code QValue}.
*/
QValue create(long value) throws RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#BOOLEAN}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#BOOLEAN}.
*
- * @param value A <code>boolean</code> containing the value
- * of the new <code>QValue</code>.
- * @return a new <code>QValue</code>.
+ * @param value A {@code boolean} containing the value
+ * of the new {@code QValue}.
+ * @return a new {@code QValue}.
*/
QValue create(boolean value) throws RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#NAME}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#NAME}.
*
- * @param value A non-null <code>Name</code>.
- * @return a new <code>QValue</code>.
+ * @param value A non-null {@code Name}.
+ * @return a new {@code QValue}.
*/
QValue create(Name value) throws RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#PATH}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#PATH}.
*
- * @param value A non-null <code>Path</code>.
- * @return a new <code>QValue</code>.
+ * @param value A non-null {@code Path}.
+ * @return a new {@code QValue}.
*/
QValue create(Path value) throws RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#DECIMAL}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#DECIMAL}.
*
- * @param value A non-null <code>BigDecimal</code>.
- * @return a new <code>QValue</code>.
+ * @param value A non-null {@code BigDecimal}.
+ * @return a new {@code QValue}.
*/
QValue create(BigDecimal value) throws RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#URI}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#URI}.
*
- * @param value A non-null <code>URI</code>.
- * @return a new <code>QValue</code>.
+ * @param value A non-null {@code URI}.
+ * @return a new {@code QValue}.
*/
QValue create(URI value) throws RepositoryException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#BINARY}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#BINARY}.
*
* @param value
- * @return a new <code>QValue</code>.
+ * @return a new {@code QValue}.
*/
QValue create(byte[] value) throws RepositoryException;
@@ -129,23 +129,23 @@ public interface QValueFactory {
* resulting QValue will be {@link javax.jcr.PropertyType#BINARY}.
*
* @param value binary stream
- * @return a new binary <code>QValue</code>.
+ * @return a new binary {@code QValue}.
* @throws RepositoryException if the value could not be created
* @throws IOException if the stream can not be consumed
*/
QValue create(InputStream value) throws RepositoryException, IOException;
/**
- * Create a new <code>QValue</code> with type {@link javax.jcr.PropertyType#BINARY}.
+ * Create a new {@code QValue} with type {@link javax.jcr.PropertyType#BINARY}.
*
* @param value
- * @return a new binary <code>QValue</code>.
+ * @return a new binary {@code QValue}.
* @throws IOException
*/
QValue create(File value) throws RepositoryException, IOException;
/**
- * Given the <code>QPropertyDefinition</code> of an <em>autocreated</em>
+ * Given the {@code QPropertyDefinition} of an <em>autocreated</em>
* property, compute suitable values to be used in transient space until
* the newly created node gets saved.
*
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QueryInfo.java Wed Sep 7 09:49:37 2011
@@ -20,9 +20,9 @@ import javax.jcr.RangeIterator;
import java.util.Map;
/**
- * <code>QueryInfo</code> is the the return value of
- * {@link RepositoryService#executeQuery(SessionInfo, String, String, Map, long, long, Map)}
- * which is used to run a query on the <code>RepositoryService</code>. It
+ * {@code QueryInfo} is the the return value of
+ * {@link RepositoryService#executeQuery(SessionInfo, String, String, Map, long, long, Map)}
+ * which is used to run a query on the {@code RepositoryService}. It
* provides access to the rows of the query result as well as to the column
* names.
*
@@ -39,14 +39,14 @@ public interface QueryInfo {
RangeIterator getRows();
/**
- * @return an array of <code>String</code>s representing the column names of
+ * @return an array of {@code String}s representing the column names of
* the query result.
* @see javax.jcr.query.QueryResult#getColumnNames()
*/
String[] getColumnNames();
/**
- * @return an array of <code>Name</code>s representing the selector names of
+ * @return an array of {@code Name}s representing the selector names of
* the query result.
* @see javax.jcr.query.QueryResult#getSelectorNames()
*/