Author: tellison
Date: Fri Jun 1 04:31:35 2007
New Revision: 543461
URL: http://svn.apache.org/viewvc?view=rev&rev=543461
Log:
Apply patch HARMONY-4020 ([classlib] [jndi] Some minor Javadoc updates in the jndi module)
Modified:
harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/Context.java
harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/InitialContext.java
harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/directory/SearchControls.java
harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/org/apache/harmony/jndi/provider/rmi/registry/RegistryContext.java
Modified: harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/Context.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/Context.java?view=diff&rev=543461&r1=543460&r2=543461
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/Context.java (original)
+++ harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/Context.java Fri
Jun 1 04:31:35 2007
@@ -505,7 +505,7 @@
* is a name which is relative to the specified parent context names.
*
* @param n a <code>Name</code>, may not be null
- * @param pfx a <code>Name</code> serves as perfix, may not be null
+ * @param pfx a <code>Name</code> serves as prefix, may not be null
* @return the combined name
* @throws NamingException if an error occurs.
*/
Modified: harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/InitialContext.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/InitialContext.java?view=diff&rev=543461&r1=543460&r2=543461
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/InitialContext.java
(original)
+++ harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/InitialContext.java
Fri Jun 1 04:31:35 2007
@@ -427,18 +427,20 @@
}
/**
- * Composes the name of this context with a name relative to this context.
- * Because an initial context could not be named relative to any context
- * except itself, the value of the prefix parameter must be an empty name.
+ * Combines two names into a composite name according to the syntax for this
+ * context. The name <code>prefix</code> is expected to be the name of one
+ * or more of the immediate parent contexts of this context, so should be an
+ * empty name for an <code>InitialContext</code>. <code>name</code>
is
+ * a name relative to this context. Neither <code>prefix</code> nor
+ * <code>name</code> may be null.
*
* @param name
- * a name relative to this context.
+ * a <code>Name</code>, may not be null
* @param prefix
- * the name of this context relative to one of its ancestors.
- *
- * @return the composition of prefix and name.
+ * a <code>Name</code> serves as prefix, may not be null
+ * @return the combined name
* @throws NamingException
- * if a naming exception happens.
+ * if an error occurs.
*/
public Name composeName(Name name, Name prefix) throws NamingException {
if (null == name) {
@@ -448,18 +450,16 @@
}
/**
- * Composes the name of this context with a name relative to this context.
- * Because an initial context could not be named relative to any context
- * except itself, the value of the prefix parameter must be an empty name.
+ * Combines two names into a composite name according to the syntax for
+ * this context. The name <code>prefix</code> is expected to be the name
of
+ * one or more of the immediate parent contexts of this context, so should
+ * be an empty string for an <code>InitialContext</code>.
+ * <code>name</code> is a name relative to this context.
*
- * @param name
- * a name relative to this context.
- * @param prefix
- * the name of this context relative to one of its ancestors.
- *
- * @return the composition of prefix and name.
- * @throws NamingException
- * if a naming exception happens.
+ * @param name a <code>Name</code>, may not be null
+ * @param prefix a <code>Name</code> serves as prefix, may not be null
+ * @return the combined name
+ * @throws NamingException if an error occurs.
*/
public String composeName(String name, String prefix)
throws NamingException {
Modified: harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/directory/SearchControls.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/directory/SearchControls.java?view=diff&rev=543461&r1=543460&r2=543461
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/directory/SearchControls.java
(original)
+++ harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/javax/naming/directory/SearchControls.java
Fri Jun 1 04:31:35 2007
@@ -118,14 +118,14 @@
private boolean derefLink;
/**
- * Flag showing whether object is returned in the search results.
+ * Flag showing whether an Object is returned in the search results.
*
* @serial
*/
private boolean returnObj;
/**
- * Contains the maximum number of search results to return.
+ * Maximum number of search results that will be returned.
*
* @serial
*/
Modified: harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/org/apache/harmony/jndi/provider/rmi/registry/RegistryContext.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/org/apache/harmony/jndi/provider/rmi/registry/RegistryContext.java?view=diff&rev=543461&r1=543460&r2=543461
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/org/apache/harmony/jndi/provider/rmi/registry/RegistryContext.java
(original)
+++ harmony/enhanced/classlib/trunk/modules/jndi/src/main/java/org/apache/harmony/jndi/provider/rmi/registry/RegistryContext.java
Fri Jun 1 04:31:35 2007
@@ -752,7 +752,7 @@
* if <code>csf</code> is not <code>null</code>.
*
* @param csf
- * Client-side socket factory used to make connections to the
+ * RMIClientSocketFactory that is used to create socket connections to the
* registry. If <code>null</code>, default socket factory is used.
* See
* {@link LocateRegistry#getRegistry(String, int, RMIClientSocketFactory)}.
|