You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by an...@apache.org on 2009/06/18 15:37:32 UTC
svn commit: r786062 - in /jackrabbit/trunk/jackrabbit-core/src/main:
java/org/apache/jackrabbit/core/ java/org/apache/jackrabbit/core/nodetype/
java/org/apache/jackrabbit/core/observation/
java/org/apache/jackrabbit/core/query/lucene/ java/org/apache/j...
Author: angela
Date: Thu Jun 18 13:37:31 2009
New Revision: 786062
URL: http://svn.apache.org/viewvc?rev=786062&view=rev
Log:
JCR-2156: Usage of "qualified name" in JavaDoc and Comments
- jackrabbit-core
Modified:
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/NodeImpl.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/PropertyId.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/ItemDefinitionImpl.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeDefinitionImpl.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeImpl.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeRegistry.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/observation/EventImpl.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/AbstractNamespaceMappings.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NamePathResolverImpl.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NodeIndexer.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AMContext.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AbstractAccessControlManager.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/state/UpdatableItemStateManager.java
jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/version/AbstractVersionManager.java
jackrabbit/trunk/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/package.html
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/NodeImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/NodeImpl.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/NodeImpl.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/NodeImpl.java Thu Jun 18 13:37:31 2009
@@ -1466,7 +1466,7 @@
* Returns the child node of <code>this</code> node with the specified
* <code>name</code>.
*
- * @param name The qualified name of the child node to retrieve.
+ * @param name The name of the child node to retrieve.
* @return The child node with the specified <code>name</code>.
* @throws ItemNotFoundException If no child node exists with the
* specified name.
@@ -1480,7 +1480,7 @@
* Returns the child node of <code>this</code> node with the specified
* <code>name</code>.
*
- * @param name The qualified name of the child node to retrieve.
+ * @param name The name of the child node to retrieve.
* @param index The index of the child node to retrieve (in the case of same-name siblings).
* @return The child node with the specified <code>name</code>.
* @throws ItemNotFoundException If no child node exists with the
@@ -1512,7 +1512,7 @@
* Returns <code>true</code> if the child node exists and <code>false</code>
* otherwise.
*
- * @param name The qualified name of the child node.
+ * @param name The name of the child node.
* @return <code>true</code> if the child node exists; <code>false</code> otherwise.
* @throws RepositoryException If an unspecified error occurs.
*/
@@ -1525,7 +1525,7 @@
* Returns <code>true</code> if the child node exists and <code>false</code>
* otherwise.
*
- * @param name The qualified name of the child node.
+ * @param name The name of the child node.
* @param index The index of the child node (in the case of same-name siblings).
* @return <code>true</code> if the child node exists; <code>false</code> otherwise.
* @throws RepositoryException If an unspecified error occurs.
@@ -1549,7 +1549,7 @@
* Returns the property of <code>this</code> node with the specified
* <code>name</code>.
*
- * @param name The qualified name of the property to retrieve.
+ * @param name The name of the property to retrieve.
* @return The property with the specified <code>name</code>.
* @throws ItemNotFoundException If no property exists with the
* specified name.
@@ -1573,7 +1573,7 @@
* Returns <code>true</code> if the property exists and <code>false</code>
* otherwise.
*
- * @param name The qualified name of the property.
+ * @param name The name of the property.
* @return <code>true</code> if the property exists; <code>false</code> otherwise.
* @throws RepositoryException If an unspecified error occurs.
*/
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/PropertyId.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/PropertyId.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/PropertyId.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/PropertyId.java Thu Jun 18 13:37:31 2009
@@ -21,7 +21,7 @@
/**
* Property identifier. An instance of this class identifies a single
- * property using the UUID of the parent node and the qualified name of
+ * property using the UUID of the parent node and the name of
* the property. Once created a property identifier instance is immutable.
*/
public class PropertyId extends ItemId {
@@ -32,7 +32,7 @@
/** id of the parent node. */
private final NodeId parentId;
- /** Qualified name of the property. */
+ /** Name of the property. */
private final Name propName;
/** the precalculated hash code */
@@ -42,7 +42,7 @@
* Creates a property identifier instance for the identified property.
*
* @param parentId the id of the parent node
- * @param propName qualified name of the property
+ * @param propName Name of the property
*/
public PropertyId(NodeId parentId, Name propName) {
if (parentId == null) {
@@ -81,9 +81,9 @@
}
/**
- * Returns the qualified name of the property.
+ * Returns the <code>Name</code> of the property.
*
- * @return qualified name
+ * @return <code>Name</code> of the property.
*/
public Name getName() {
return propName;
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/ItemDefinitionImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/ItemDefinitionImpl.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/ItemDefinitionImpl.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/ItemDefinitionImpl.java Thu Jun 18 13:37:31 2009
@@ -50,7 +50,8 @@
protected final NodeTypeManagerImpl ntMgr;
/**
- * The name/path resolver used to translate qualified names to JCR names.
+ * The name/path resolver used to translate <code>Name</code>s to JCR name
+ * strings.
*/
protected final NamePathResolver resolver;
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeDefinitionImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeDefinitionImpl.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeDefinitionImpl.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeDefinitionImpl.java Thu Jun 18 13:37:31 2009
@@ -38,7 +38,7 @@
private static Logger log = LoggerFactory.getLogger(NodeTypeDefinitionImpl.class);
private final NodeTypeDef ntd;
- // resolver used to translate qualified names to JCR names
+ // resolver used to translate <code>Name</code>s to JCR name strings.
private final NamePathResolver resolver;
private final ValueFactory valueFactory;
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeImpl.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeImpl.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeImpl.java Thu Jun 18 13:37:31 2009
@@ -51,7 +51,7 @@
private final NodeTypeDef ntd;
private final EffectiveNodeType ent;
private final NodeTypeManagerImpl ntMgr;
- // resolver used to translate qualified names to JCR names
+ // resolver used to translate translate <code>Name</code>s to JCR name strings.
private final NamePathResolver resolver;
// value factory used for type conversion
private final ValueFactory valueFactory;
@@ -186,9 +186,9 @@
}
/**
- * Returns the 'internal', i.e. the fully qualified name.
+ * Returns the <code>Name</code> of this node type.
*
- * @return the qualified name
+ * @return the name
*/
public Name getQName() {
return ntd.getName();
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeRegistry.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeRegistry.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeRegistry.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/nodetype/NodeTypeRegistry.java Thu Jun 18 13:37:31 2009
@@ -1383,7 +1383,7 @@
* @param ntd
* @param entCache
* @param ntdCache cache of 'known' node type definitions, used to resolve dependencies
- * @param nsReg namespace registry used for validating qualified names
+ * @param nsReg namespace registry used for validatingatch names
* @param lenient flag governing whether validation can be lenient or has to be strict
* @return an effective node type representation of the specified <code>NodeTypeDef</code>
* @throws InvalidNodeTypeDefException
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/observation/EventImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/observation/EventImpl.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/observation/EventImpl.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/observation/EventImpl.java Thu Jun 18 13:37:31 2009
@@ -158,9 +158,9 @@
//-----------------------------------------------------------< EventImpl >
/**
- * Returns the qualified path of this event.
+ * Returns the <code>Path</code> of this event.
*
- * @return qualified path
+ * @return path
* @throws RepositoryException if the path can't be constructed
*/
public Path getQPath() throws RepositoryException {
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/AbstractNamespaceMappings.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/AbstractNamespaceMappings.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/AbstractNamespaceMappings.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/AbstractNamespaceMappings.java Thu Jun 18 13:37:31 2009
@@ -32,7 +32,7 @@
implements NamespaceMappings, NamespaceResolver {
/**
- * The name resolver used to translate the qualified name to JCR name
+ * The name resolver used to translate the <code>Name</code>s to JCR name strings.
*/
private final NamePathResolver resolver;
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NamePathResolverImpl.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NamePathResolverImpl.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NamePathResolverImpl.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NamePathResolverImpl.java Thu Jun 18 13:37:31 2009
@@ -79,10 +79,10 @@
//-------------------------------------------------------< NameResolver >---
/**
- * Parses the prefixed JCR name and returns the resolved qualified name.
+ * Parses the prefixed JCR name and returns the resolved <code>Name</code> object.
*
- * @param name prefixed JCR name
- * @return qualified name
+ * @param name The JCR name string.
+ * @return The corresponding <code>Name</code>.
* @throws IllegalNameException if the JCR name format is invalid
* @throws NamespaceException if the namespace prefix can not be resolved
*/
@@ -91,14 +91,14 @@
}
/**
- * Returns the prefixed JCR name for the given qualified name.
+ * Returns the qualified JCR name for the given <code>Name</code>.
* Note, that the JCR prefix is always retrieved from the NamespaceResolver
* even if the name is in the defaut namespace. This is a special treatement
* for query specific implementation, which defines a prefix for all namespace
* URIs including the default namespace.
*
- * @param name qualified name
- * @return prefixed JCR name
+ * @param name A <code>Name</code> object.
+ * @return The corresponding qualified JCR name string.
* @throws NamespaceException if the namespace URI can not be resolved
*/
public String getJCRName(Name name) throws NamespaceException {
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NodeIndexer.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NodeIndexer.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NodeIndexer.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/query/lucene/NodeIndexer.java Thu Jun 18 13:37:31 2009
@@ -738,7 +738,7 @@
/**
* Adds the name value to the document as the named field. The name
* value is converted to an indexable string treating the internal value
- * as a qualified name and mapping the name space using the name space
+ * as a <code>Name</code> and mapping the name space using the name space
* mappings with which this class has been created.
*
* @param doc The document to which to add the field
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AMContext.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AMContext.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AMContext.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AMContext.java Thu Jun 18 13:37:31 2009
@@ -56,7 +56,8 @@
private final HierarchyManager hierMgr;
/**
- * name and path resolver for resolving namespaces in qualified paths
+ * name and path resolver for resolving JCR name/path strings to internal
+ * Name/Path objects (and vice versa).
*/
private final NamePathResolver resolver;
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AbstractAccessControlManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AbstractAccessControlManager.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AbstractAccessControlManager.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/security/AbstractAccessControlManager.java Thu Jun 18 13:37:31 2009
@@ -46,7 +46,7 @@
*
* @param absPath Path to an existing node.
* @return Always returns all registered <code>Privilege</code>s.
- * @see AccessControlManager#getSupportedPrivileges(String)
+ * @see javax.jcr.security.AccessControlManager#getSupportedPrivileges(String)
*/
public Privilege[] getSupportedPrivileges(String absPath) throws PathNotFoundException, RepositoryException {
checkInitialized();
@@ -57,7 +57,7 @@
}
/**
- * @see AccessControlManager#privilegeFromName(String)
+ * @see javax.jcr.security.AccessControlManager#privilegeFromName(String)
*/
public Privilege privilegeFromName(String privilegeName)
throws AccessControlException, RepositoryException {
@@ -71,7 +71,7 @@
*
* @param absPath Path to an existing node.
* @return always returns <code>null</code>.
- * @see AccessControlManager#getApplicablePolicies(String)
+ * @see javax.jcr.security.AccessControlManager#getApplicablePolicies(String)
*/
public AccessControlPolicy[] getPolicies(String absPath) throws PathNotFoundException, AccessDeniedException, RepositoryException {
checkInitialized();
@@ -86,7 +86,7 @@
*
* @param absPath Path to an existing node.
* @return always returns an empty iterator.
- * @see AccessControlManager#getApplicablePolicies(String)
+ * @see javax.jcr.security.AccessControlManager#getApplicablePolicies(String)
*/
public AccessControlPolicyIterator getApplicablePolicies(String absPath) throws PathNotFoundException, AccessDeniedException, RepositoryException {
checkInitialized();
@@ -99,7 +99,7 @@
/**
* Always throws <code>AccessControlException</code>
*
- * @see AccessControlManager#setPolicy(String, AccessControlPolicy)
+ * @see javax.jcr.security.AccessControlManager#setPolicy(String, AccessControlPolicy)
*/
public void setPolicy(String absPath, AccessControlPolicy policy) throws PathNotFoundException, AccessControlException, AccessDeniedException, RepositoryException {
checkInitialized();
@@ -111,7 +111,7 @@
/**
* Always throws <code>AccessControlException</code>
*
- * @see AccessControlManager#removePolicy(String, AccessControlPolicy)
+ * @see javax.jcr.security.AccessControlManager#removePolicy(String, AccessControlPolicy)
*/
public void removePolicy(String absPath, AccessControlPolicy policy) throws PathNotFoundException, AccessControlException, AccessDeniedException, RepositoryException {
checkInitialized();
@@ -160,8 +160,7 @@
protected abstract PrivilegeRegistry getPrivilegeRegistry() throws RepositoryException;
/**
- * Build a qualified path from the specified <code>absPath</code> and test
- * if it is really absolute and points to an existing node.
+ * Tests if the given <code>absPath</code> is absolute and points to an existing node.
*
* @param absPath Path to an existing node.
* @throws PathNotFoundException if no node at <code>absPath</code> exists
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/state/UpdatableItemStateManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/state/UpdatableItemStateManager.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/state/UpdatableItemStateManager.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/state/UpdatableItemStateManager.java Thu Jun 18 13:37:31 2009
@@ -53,7 +53,7 @@
* on the returned object to make it persistent.
*
* @param id the id of the node
- * @param nodeTypeName qualified node type name
+ * @param nodeTypeName The node type name
* @param parentId parent node's id
* @return a node state
* @throws IllegalStateException if the manager is not in edit mode.
@@ -66,7 +66,7 @@
* i.e. not yet existing state. Call {@link #store}
* on the returned object to make it persistent.
*
- * @param propName qualified property name
+ * @param propName property name
* @param parentId parent node Id
* @return a property state
* @throws IllegalStateException if the manager is not in edit mode.
Modified: jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/version/AbstractVersionManager.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/version/AbstractVersionManager.java?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/version/AbstractVersionManager.java (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/java/org/apache/jackrabbit/core/version/AbstractVersionManager.java Thu Jun 18 13:37:31 2009
@@ -488,7 +488,7 @@
* namespace.
*
* @param name string name
- * @return qualified name
+ * @return A <code>Name</code> object.
*/
private Name getName(String name) {
return NameFactoryImpl.getInstance().create(Name.NS_DEFAULT_URI, name);
Modified: jackrabbit/trunk/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/package.html
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/package.html?rev=786062&r1=786061&r2=786062&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/package.html (original)
+++ jackrabbit/trunk/jackrabbit-core/src/main/javadoc/org/apache/jackrabbit/core/package.html Thu Jun 18 13:37:31 2009
@@ -76,7 +76,7 @@
<p/>
Every repository item is uniquely identified by its <code>ItemId</code>. The id
of a node (<code>NodeId</code>) consists of the node's uuid. The id of a property
-(<code>PropertyId</code>) consists of the parent node's uuid and the qualified
+(<code>PropertyId</code>) consists of the parent node's uuid and the
name of the property.
<h2>Item managers</h2>