4682009: Typo in javadocs in javax/naming
authorigerasim
Sat, 15 Feb 2014 10:17:35 +0400
changeset 22974 4bf6c0d73bb8
parent 22973 616ad2891b71
child 22975 1a8002758a3d
4682009: Typo in javadocs in javax/naming Reviewed-by: lancea, alanb
jdk/src/share/classes/javax/naming/AuthenticationException.java
jdk/src/share/classes/javax/naming/AuthenticationNotSupportedException.java
jdk/src/share/classes/javax/naming/CannotProceedException.java
jdk/src/share/classes/javax/naming/CompositeName.java
jdk/src/share/classes/javax/naming/CompoundName.java
jdk/src/share/classes/javax/naming/LinkException.java
jdk/src/share/classes/javax/naming/LinkLoopException.java
jdk/src/share/classes/javax/naming/MalformedLinkException.java
jdk/src/share/classes/javax/naming/NamingException.java
jdk/src/share/classes/javax/naming/RefAddr.java
jdk/src/share/classes/javax/naming/Reference.java
jdk/src/share/classes/javax/naming/Referenceable.java
--- a/jdk/src/share/classes/javax/naming/AuthenticationException.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/AuthenticationException.java	Sat Feb 15 10:17:35 2014 +0400
@@ -29,7 +29,7 @@
   * This exception is thrown when an authentication error occurs while
   * accessing the naming or directory service.
   * An authentication error can happen, for example, when the credentials
-  * supplied by the user program is invalid or otherwise fails to
+  * supplied by the user program are invalid or otherwise fail to
   * authenticate the user to the naming/directory service.
   *<p>
   * If the program wants to handle this exception in particular, it
@@ -37,7 +37,7 @@
   * catch NamingException. After catching AuthenticationException, the
   * program could reattempt the authentication by updating
   * the resolved context's environment properties with the appropriate
-  * appropriate credentials.
+  * credentials.
   * <p>
   * Synchronization and serialization issues that apply to NamingException
   * apply directly here.
--- a/jdk/src/share/classes/javax/naming/AuthenticationNotSupportedException.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/AuthenticationNotSupportedException.java	Sat Feb 15 10:17:35 2014 +0400
@@ -67,7 +67,7 @@
 
     /**
       * Constructs a new instance of AuthenticationNotSupportedException
-      * all name resolution fields and explanation initialized to null.
+      * with all name resolution fields and explanation initialized to null.
       */
     public AuthenticationNotSupportedException() {
         super();
--- a/jdk/src/share/classes/javax/naming/CannotProceedException.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/CannotProceedException.java	Sat Feb 15 10:17:35 2014 +0400
@@ -64,7 +64,7 @@
     /**
      * Contains the remaining unresolved part of the second
      * "name" argument to Context.rename().
-     * This information necessary for
+     * This information is necessary for
      * continuing the Context.rename() operation.
      * <p>
      * This field is initialized to null.
--- a/jdk/src/share/classes/javax/naming/CompositeName.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/CompositeName.java	Sat Feb 15 10:17:35 2014 +0400
@@ -205,7 +205,7 @@
     private transient NameImpl impl;
     /**
       * Constructs a new composite name instance using the components
-      * specified by 'comps'. This protected method is intended to be
+      * specified by 'comps'. This protected method is intended
       * to be used by subclasses of CompositeName when they override
       * methods such as clone(), getPrefix(), getSuffix().
       *
@@ -436,7 +436,7 @@
 
     /**
       * Determines whether a composite name is a suffix of this composite name.
-      * A composite name 'n' is a suffix if it it is equal to
+      * A composite name 'n' is a suffix if it is equal to
       * getSuffix(size()-n.size())--in other words, this
       * composite name ends with 'n'.
       * If n is null or not a composite name, false is returned.
--- a/jdk/src/share/classes/javax/naming/CompoundName.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/CompoundName.java	Sat Feb 15 10:17:35 2014 +0400
@@ -165,7 +165,7 @@
 
     /**
       * Constructs a new compound name instance using the components
-      * specified in comps and syntax. This protected method is intended to be
+      * specified in comps and syntax. This protected method is intended
       * to be used by subclasses of CompoundName when they override
       * methods such as clone(), getPrefix(), getSuffix().
       *
@@ -365,7 +365,7 @@
       * components in this compound name.
       * The result and this compound name share the same syntax.
       * Subsequent changes to
-      * this compound name does not affect the name that is returned and
+      * this compound name do not affect the name that is returned and
       * vice versa.
       *
       * @param  posn    The 0-based index of the component at which to stop.
@@ -385,7 +385,7 @@
       * components in this compound name.
       * The result and this compound name share the same syntax.
       * Subsequent changes to
-      * this compound name does not affect the name that is returned.
+      * this compound name do not affect the name that is returned.
       *
       * @param  posn    The 0-based index of the component at which to start.
       *                 Must be in the range [0,size()].
@@ -423,7 +423,7 @@
 
     /**
       * Determines whether a compound name is a suffix of this compound name.
-      * A compound name 'n' is a suffix if it it is equal to
+      * A compound name 'n' is a suffix if it is equal to
       * getSuffix(size()-n.size())--in other words, this
       * compound name ends with 'n'.
       * If n is null or not a compound name, false is returned.
--- a/jdk/src/share/classes/javax/naming/LinkException.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/LinkException.java	Sat Feb 15 10:17:35 2014 +0400
@@ -26,11 +26,11 @@
 package javax.naming;
 
 /**
- * This exception is used to describe problems encounter while resolving links.
- * Addition information is added to the base NamingException for pinpointing
+ * This exception is used to describe problems encountered while resolving links.
+ * Additional information is added to the base NamingException for pinpointing
  * the problem with the link.
  *<p>
- * Analogous to how NamingException captures name resolution information,
+ * Analogously to how NamingException captures name resolution information,
  * LinkException captures "link"-name resolution information pinpointing
  * the problem encountered while resolving a link. All these fields may
  * be null.
@@ -111,7 +111,7 @@
     protected String linkExplanation;
 
     /**
-      * Constructs a new instance of LinkException with an explanation
+      * Constructs a new instance of LinkException with an explanation.
       * All the other fields are initialized to null.
       * @param  explanation     A possibly null string containing additional
       *                         detail about this exception.
@@ -176,7 +176,7 @@
     }
 
     /**
-      * Retrieves the explanation associated with the problem encounter
+      * Retrieves the explanation associated with the problem encountered
       * when resolving a link.
       *
       * @return The possibly null detail string explaining more about the problem
@@ -190,7 +190,7 @@
     }
 
     /**
-      * Sets the explanation associated with the problem encounter
+      * Sets the explanation associated with the problem encountered
       * when resolving a link.
       *
       * @param msg The possibly null detail string explaining more about the problem
@@ -211,7 +211,7 @@
      * invoke this method using the resulting composite name.
      *<p>
      * A copy of <code>name</code> is made and stored.
-     * Subsequent changes to <code>name</code> does not
+     * Subsequent changes to <code>name</code> do not
      * affect the copy in this NamingException and vice versa.
      *
      *
@@ -237,7 +237,7 @@
      * invoke this method using the resulting composite name.
      *<p>
      * A copy of <code>name</code> is made and stored.
-     * Subsequent changes to <code>name</code> does not
+     * Subsequent changes to <code>name</code> do not
      * affect the copy in this NamingException and vice versa.
      *
      * @param name The name to set remaining link name to. This can be null.
--- a/jdk/src/share/classes/javax/naming/LinkLoopException.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/LinkLoopException.java	Sat Feb 15 10:17:35 2014 +0400
@@ -27,7 +27,7 @@
 
 /**
   * This exception is thrown when
-  * a loop was detected will attempting to resolve a link, or an implementation
+  * a loop was detected while attempting to resolve a link, or an implementation
   * specific limit on link counts has been reached.
   * <p>
   * Synchronization and serialization issues that apply to LinkException
@@ -42,7 +42,7 @@
 
 public class LinkLoopException extends LinkException {
     /**
-      * Constructs a new instance of LinkLoopException with an explanation
+      * Constructs a new instance of LinkLoopException with an explanation.
       * All the other fields are initialized to null.
       * @param  explanation     A possibly null string containing additional
       *                         detail about this exception.
--- a/jdk/src/share/classes/javax/naming/MalformedLinkException.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/MalformedLinkException.java	Sat Feb 15 10:17:35 2014 +0400
@@ -42,7 +42,7 @@
 
 public class MalformedLinkException extends LinkException {
     /**
-      * Constructs a new instance of MalformedLinkException with an explanation
+      * Constructs a new instance of MalformedLinkException with an explanation.
       * All the other fields are initialized to null.
       * @param  explanation     A possibly null string containing additional
       *                         detail about this exception.
--- a/jdk/src/share/classes/javax/naming/NamingException.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/NamingException.java	Sat Feb 15 10:17:35 2014 +0400
@@ -201,7 +201,7 @@
      * invoke this method using the resulting composite name.
      *<p>
      * A copy of <code>name</code> is made and stored.
-     * Subsequent changes to <code>name</code> does not
+     * Subsequent changes to <code>name</code> do not
      * affect the copy in this NamingException and vice versa.
      *
      * @param name The possibly null name to set resolved name to.
@@ -225,7 +225,7 @@
      * invoke this method using the resulting composite name.
      *<p>
      * A copy of <code>name</code> is made and stored.
-     * Subsequent changes to <code>name</code> does not
+     * Subsequent changes to <code>name</code> do not
      * affect the copy in this NamingException and vice versa.
      * @param name The possibly null name to set remaining name to.
      *          If null, it sets the remaining name field to null.
@@ -279,7 +279,7 @@
       * a compound name, you should "stringify" the compound name
       * then invoke the overloaded form that accepts a String parameter.
       *<p>
-      * Subsequent changes to <code>name</code> does not
+      * Subsequent changes to <code>name</code> do not
       * affect the remaining name field in this NamingException and vice versa.
       * @param name The possibly null name containing ordered components to add.
       *                 If name is null, this method does not do anything.
--- a/jdk/src/share/classes/javax/naming/RefAddr.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/RefAddr.java	Sat Feb 15 10:17:35 2014 +0400
@@ -90,7 +90,7 @@
     /**
       * Determines whether obj is equal to this RefAddr.
       *<p>
-      * obj is equal to this RefAddr all of these conditions are true
+      * obj is equal to this RefAddr if all of these conditions are true
       *<ul>
       *<li> non-null
       *<li> instance of RefAddr
--- a/jdk/src/share/classes/javax/naming/Reference.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/Reference.java	Sat Feb 15 10:17:35 2014 +0400
@@ -218,8 +218,8 @@
       * String.compareTo() is used to test the equality of the address types.
       *
       * @param addrType The non-null address type for which to find the address.
-      * @return The address in this reference with address type 'addrType;
-      *         null if no such address exist.
+      * @return The address in this reference with address type 'addrType';
+      *         null if no such address exists.
       */
     public RefAddr get(String addrType) {
         int len = addrs.size();
--- a/jdk/src/share/classes/javax/naming/Referenceable.java	Fri Feb 14 15:21:26 2014 +0000
+++ b/jdk/src/share/classes/javax/naming/Referenceable.java	Sat Feb 15 10:17:35 2014 +0400
@@ -33,7 +33,7 @@
   * objects which themselves are not directly bound to the naming system.
   * Such objects can implement the Referenceable interface as a way
   * for programs that use that object to determine what its Reference is.
-  * For example, when binding a object, if an object implements the
+  * For example, when binding an object, if an object implements the
   * Referenceable interface, getReference() can be invoked on the object to
   * get its Reference to use for binding.
   *