This method will modify env and save + *
This method will modify {@code env} and save * a reference to it. The caller may no longer modify it. * * @param env environment passed to initial context constructor. @@ -195,7 +195,7 @@ public final class ResourceManager { * may in turn contain values that come from system properties, * or application resource files. * - * If concat is true and both the environment and the provider + * If {@code concat} is true and both the environment and the provider * resource file contain the property, the two values are concatenated * (with a ':' separator). * diff --git a/jdk/src/java.naming/share/classes/javax/naming/Binding.java b/jdk/src/java.naming/share/classes/javax/naming/Binding.java index 32ad3562446..662fe0a91a6 100644 --- a/jdk/src/java.naming/share/classes/javax/naming/Binding.java +++ b/jdk/src/java.naming/share/classes/javax/naming/Binding.java @@ -49,7 +49,7 @@ public class Binding extends NameClassPair { /** * Contains this binding's object. * It is initialized by the constructor and can be updated using - * setObject. + * {@code setObject}. * @serial * @see #getObject * @see #setObject @@ -59,9 +59,9 @@ public class Binding extends NameClassPair { /** * Constructs an instance of a Binding given its name and object. *
- * getClassName() will return - * the class name of obj (or null if obj is null) - * unless the class name has been explicitly set using setClassName() + * {@code getClassName()} will return + * the class name of {@code obj} (or null if {@code obj} is null) + * unless the class name has been explicitly set using {@code setClassName()} * * @param name The non-null name of the object. It is relative * to the target context (which is @@ -78,9 +78,9 @@ public class Binding extends NameClassPair { * Constructs an instance of a Binding given its name, object, and whether * the name is relative. *
- * getClassName() will return the class name of obj
- * (or null if obj is null) unless the class name has been
- * explicitly set using setClassName()
+ * {@code getClassName()} will return the class name of {@code obj}
+ * (or null if {@code obj} is null) unless the class name has been
+ * explicitly set using {@code setClassName()}
*
* @param name The non-null string name of the object.
* @param obj The possibly null object bound to name.
@@ -104,9 +104,9 @@ public class Binding extends NameClassPair {
* to the target context (which is
* named by the first parameter of the listBindings() method)
* @param className The possibly null class name of the object
- * bound to name. If null, the class name of obj is
- * returned by getClassName(). If obj is also
- * null, getClassName() will return null.
+ * bound to {@code name}. If null, the class name of {@code obj} is
+ * returned by {@code getClassName()}. If {@code obj} is also
+ * null, {@code getClassName()} will return null.
* @param obj The possibly null object bound to name.
* @see NameClassPair#setClassName
*/
@@ -121,9 +121,9 @@ public class Binding extends NameClassPair {
*
* @param name The non-null string name of the object.
* @param className The possibly null class name of the object
- * bound to name. If null, the class name of obj is
- * returned by getClassName(). If obj is also
- * null, getClassName() will return null.
+ * bound to {@code name}. If null, the class name of {@code obj} is
+ * returned by {@code getClassName()}. If {@code obj} is also
+ * null, {@code getClassName()} will return null.
* @param obj The possibly null object bound to name.
* @param isRelative true if name is a name relative
* to the target context (which is named by
diff --git a/jdk/src/java.naming/share/classes/javax/naming/CannotProceedException.java b/jdk/src/java.naming/share/classes/javax/naming/CannotProceedException.java
index da3f55b1087..c681e335c61 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/CannotProceedException.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/CannotProceedException.java
@@ -93,9 +93,9 @@ public class CannotProceedException extends NamingException {
/**
* Contains the name of the resolved object, relative
- * to the context altNameCtx. It is a composite name.
+ * to the context {@code altNameCtx}. It is a composite name.
* If null, then no name is specified.
- * See the javax.naming.spi.ObjectFactory.getObjectInstance
+ * See the {@code javax.naming.spi.ObjectFactory.getObjectInstance}
* method for details on how this is used.
*
* This field is initialized to null.
@@ -112,9 +112,9 @@ public class CannotProceedException extends NamingException {
/**
* Contains the context relative to which
- * altName is specified. If null, then the default initial
+ * {@code altName} is specified. If null, then the default initial
* context is implied.
- * See the javax.naming.spi.ObjectFactory.getObjectInstance
+ * See the {@code javax.naming.spi.ObjectFactory.getObjectInstance}
* method for details on how this is used.
*
* This field is initialized to null.
@@ -189,16 +189,16 @@ public class CannotProceedException extends NamingException {
/**
* Sets the "remaining new name" field of this exception.
- * This is the value returned by getRemainingNewName().
+ * This is the value returned by {@code getRemainingNewName()}.
*
- * newName is a composite name. If the intent is to set + * {@code newName} is a composite name. If the intent is to set * this field using a compound name or string, you must * "stringify" the compound name, and create a composite * name with a single component using the string. You can then * invoke this method using the resulting composite name. *
- * A copy of newName is made and stored.
- * Subsequent changes to name does not
+ * A copy of {@code newName} is made and stored.
+ * Subsequent changes to {@code name} does not
* affect the copy in this NamingException and vice versa.
*
* @param newName The possibly null name to set the "remaining new name" to.
@@ -214,13 +214,13 @@ public class CannotProceedException extends NamingException {
}
/**
- * Retrieves the altName field of this exception.
+ * Retrieves the {@code altName} field of this exception.
* This is the name of the resolved object, relative to the context
- * altNameCtx. It will be used during a subsequent call to the
- * javax.naming.spi.ObjectFactory.getObjectInstance method.
+ * {@code altNameCtx}. It will be used during a subsequent call to the
+ * {@code javax.naming.spi.ObjectFactory.getObjectInstance} method.
*
* @return The name of the resolved object, relative to
- * altNameCtx.
+ * {@code altNameCtx}.
* It is a composite name. If null, then no name is specified.
*
* @see #setAltName
@@ -232,10 +232,10 @@ public class CannotProceedException extends NamingException {
}
/**
- * Sets the altName field of this exception.
+ * Sets the {@code altName} field of this exception.
*
* @param altName The name of the resolved object, relative to
- * altNameCtx.
+ * {@code altNameCtx}.
* It is a composite name.
* If null, then no name is specified.
*
@@ -247,12 +247,12 @@ public class CannotProceedException extends NamingException {
}
/**
- * Retrieves the altNameCtx field of this exception.
- * This is the context relative to which altName is named.
+ * Retrieves the {@code altNameCtx} field of this exception.
+ * This is the context relative to which {@code altName} is named.
* It will be used during a subsequent call to the
- * javax.naming.spi.ObjectFactory.getObjectInstance method.
+ * {@code javax.naming.spi.ObjectFactory.getObjectInstance} method.
*
- * @return The context relative to which altName is named.
+ * @return The context relative to which {@code altName} is named.
* If null, then the default initial context is implied.
*
* @see #setAltNameCtx
@@ -264,10 +264,10 @@ public class CannotProceedException extends NamingException {
}
/**
- * Sets the altNameCtx field of this exception.
+ * Sets the {@code altNameCtx} field of this exception.
*
* @param altNameCtx
- * The context relative to which altName
+ * The context relative to which {@code altName}
* is named. If null, then the default initial context
* is implied.
*
diff --git a/jdk/src/java.naming/share/classes/javax/naming/CompositeName.java b/jdk/src/java.naming/share/classes/javax/naming/CompositeName.java
index 93ef152c64b..50534a2b5a6 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/CompositeName.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/CompositeName.java
@@ -76,7 +76,7 @@ import java.util.Properties;
*
syntax.
+ * by {@code syntax}.
*/
public CompoundName(String n, Properties syntax) throws InvalidNameException {
if (syntax == null) {
@@ -549,9 +549,9 @@ public class CompoundName implements Name {
/**
* Overridden to avoid implementation dependency.
- * @serialData The syntax Properties, followed by
- * the number of components (an int), and the individual
- * components (each a String).
+ * @serialData The syntax {@code Properties}, followed by
+ * the number of components (an {@code int}), and the individual
+ * components (each a {@code String}).
*/
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
diff --git a/jdk/src/java.naming/share/classes/javax/naming/Context.java b/jdk/src/java.naming/share/classes/javax/naming/Context.java
index 8ff5b041eb5..76050396c26 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/Context.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/Context.java
@@ -33,7 +33,7 @@ import java.util.Hashtable;
* It contains methods for examining and updating these bindings.
*
* @@ -47,31 +47,31 @@ import java.util.Hashtable; * The second version instead has a link to the first: the same * documentation applies to both. *
- * For systems that support federation, String name arguments to - * Context methods are composite names. Name arguments that are - * instances of CompositeName are treated as composite names, - * while Name arguments that are not instances of - * CompositeName are treated as compound names (which might be - * instances of CompoundName or other implementations of compound - * names). This allows the results of NameParser.parse() to be used as - * arguments to the Context methods. + * For systems that support federation, {@code String} name arguments to + * {@code Context} methods are composite names. Name arguments that are + * instances of {@code CompositeName} are treated as composite names, + * while {@code Name} arguments that are not instances of + * {@code CompositeName} are treated as compound names (which might be + * instances of {@code CompoundName} or other implementations of compound + * names). This allows the results of {@code NameParser.parse()} to be used as + * arguments to the {@code Context} methods. * Prior to JNDI 1.2, all name arguments were treated as composite names. *
* Furthermore, for systems that support federation, all names returned - * in a NamingEnumeration - * from list() and listBindings() are composite names + * in a {@code NamingEnumeration} + * from {@code list()} and {@code listBindings()} are composite names * represented as strings. - * See CompositeName for the string syntax of names. + * See {@code CompositeName} for the string syntax of names. *
* For systems that do not support federation, the name arguments (in - * either Name or String forms) and the names returned in - * NamingEnumeration may be names in their own namespace rather than + * either {@code Name} or {@code String} forms) and the names returned in + * {@code NamingEnumeration} may be names in their own namespace rather than * names in a composite namespace, at the discretion of the service * provider. * *
* For purposes of concurrency control, - * a Context operation that returns a NamingEnumeration is + * a Context operation that returns a {@code NamingEnumeration} is * not considered to have completed while the enumeration is still in * use, or while any referrals generated by that operation are still * being followed. * * *
* The environment is inherited from the parent context as @@ -145,7 +145,7 @@ import java.util.Hashtable; * application components and service providers may be distributed * along with resource files. * A JNDI resource file is a file in the properties file format (see - * {@link java.util.Properties#load java.util.Properties}), + * {@link java.util.Properties#load java.util.Properties}), * containing a list of key/value pairs. * The key is the name of the property (e.g. "java.naming.factory.object") * and the value is a string in the format defined @@ -170,18 +170,18 @@ import java.util.Hashtable; * Each service provider has an optional resource that lists properties * specific to that provider. The name of this resource is: *
- * [prefix/]jndiprovider.properties + * [prefix/]{@code jndiprovider.properties} ** where prefix is * the package name of the provider's context implementation(s), * with each period (".") converted to a slash ("/"). * * For example, suppose a service provider defines a context - * implementation with class name com.sun.jndi.ldap.LdapCtx. + * implementation with class name {@code com.sun.jndi.ldap.LdapCtx}. * The provider resource for this provider is named - * com/sun/jndi/ldap/jndiprovider.properties. If the class is + * {@code com/sun/jndi/ldap/jndiprovider.properties}. If the class is * not in a package, the resource's name is simply - * jndiprovider.properties. + * {@code jndiprovider.properties}. * *
* @@ -204,11 +204,11 @@ import java.util.Hashtable; * * When an application is deployed, it will generally have several * codebase directories and JARs in its classpath. JNDI locates (using - * {@link ClassLoader#getResources ClassLoader.getResources()}) - * all application resource files named jndi.properties + * {@link ClassLoader#getResources ClassLoader.getResources()}) + * all application resource files named {@code jndi.properties} * in the classpath. * In addition, if the Java installation directory contains a built-in - * properties file, typically conf/jndi.properties, + * properties file, typically {@code conf/jndi.properties}, * JNDI treats it as an additional application resource file. * All of the properties contained in these files are placed * into the environment of the initial context. This environment @@ -220,7 +220,7 @@ import java.util.Hashtable; * sense to do so, it concatenates all of the values (details are given * below). * For example, if the "java.naming.factory.object" property is found in - * three jndi.properties resource files, the + * three {@code jndi.properties} resource files, the * list of object factories is a concatenation of the property * values from all three files. * Using this scheme, each deployable component is responsible for @@ -234,7 +234,7 @@ import java.util.Hashtable; * is initialized with properties defined in the environment parameter * passed to the constructor, the system properties, * and the application resource files. See - * InitialContext + * {@code InitialContext} * for details. * This initial environment is then inherited by other context instances. * @@ -244,7 +244,7 @@ import java.util.Hashtable; * the values from the following two sources, in order: *
If the object is a DirContext, any existing attributes + *
If the object is a {@code DirContext}, any existing attributes * associated with the name are replaced with those of the object. * Otherwise, any existing attributes associated with the name remain * unchanged. @@ -388,7 +388,7 @@ public interface Context { *
This method is idempotent. * It succeeds even if the terminal atomic name * is not bound in the target context, but throws - * NameNotFoundException + * {@code NameNotFoundException} * if any of the intermediate contexts do not exist. * *
Any attributes associated with the name are removed.
@@ -424,7 +424,7 @@ public interface Context {
* the name of the existing binding; may not be empty
* @param newName
* the name of the new binding; may not be empty
- * @throws NameAlreadyBoundException if newName is already bound
+ * @throws NameAlreadyBoundException if {@code newName} is already bound
* @throws NamingException if a naming exception is encountered
*
* @see #rename(String, String)
@@ -442,7 +442,7 @@ public interface Context {
* the name of the existing binding; may not be empty
* @param newName
* the name of the new binding; may not be empty
- * @throws NameAlreadyBoundException if newName is already bound
+ * @throws NameAlreadyBoundException if {@code newName} is already bound
* @throws NamingException if a naming exception is encountered
*/
public void rename(String oldName, String newName) throws NamingException;
@@ -459,7 +459,7 @@ public interface Context {
* the name of the context to list
* @return an enumeration of the names and class names of the
* bindings in this context. Each element of the
- * enumeration is of type NameClassPair.
+ * enumeration is of type {@code NameClassPair}.
* @throws NamingException if a naming exception is encountered
*
* @see #list(String)
@@ -478,7 +478,7 @@ public interface Context {
* the name of the context to list
* @return an enumeration of the names and class names of the
* bindings in this context. Each element of the
- * enumeration is of type NameClassPair.
+ * enumeration is of type {@code NameClassPair}.
* @throws NamingException if a naming exception is encountered
*/
public NamingEnumeration This method is idempotent.
* It succeeds even if the terminal atomic name
* is not bound in the target context, but throws
- * NameNotFoundException
+ * {@code NameNotFoundException}
* if any of the intermediate contexts do not exist.
*
* In a federated naming system, a context from one naming system
@@ -537,11 +537,11 @@ public interface Context {
* look up and perform operations on the foreign context using a
* composite name. However, an attempt destroy the context using
* this composite name will fail with
- * NotContextException, because the foreign context is not
+ * {@code NotContextException}, because the foreign context is not
* a "subcontext" of the context in which it is bound.
- * Instead, use unbind() to remove the
+ * Instead, use {@code unbind()} to remove the
* binding of the foreign context. Destroying the foreign context
- * requires that the destroySubcontext() be performed
+ * requires that the {@code destroySubcontext()} be performed
* on a context from the foreign context's "native" naming system.
*
* @param name
@@ -611,12 +611,12 @@ public interface Context {
/**
* Retrieves the named object, following links except
* for the terminal atomic component of the name.
- * If the object bound to name is not a link,
+ * If the object bound to {@code name} is not a link,
* returns the object itself.
*
* @param name
* the name of the object to look up
- * @return the object bound to name, not following the
+ * @return the object bound to {@code name}, not following the
* terminal link (if any).
* @throws NamingException if a naming exception is encountered
*
@@ -631,7 +631,7 @@ public interface Context {
*
* @param name
* the name of the object to look up
- * @return the object bound to name, not following the
+ * @return the object bound to {@code name}, not following the
* terminal link (if any)
* @throws NamingException if a naming exception is encountered
*/
@@ -643,8 +643,8 @@ public interface Context {
* parse names differently. This method allows an application
* to get a parser for parsing names into their atomic components
* using the naming convention of a particular naming system.
- * Within any single naming system, NameParser objects
- * returned by this method must be equal (using the equals()
+ * Within any single naming system, {@code NameParser} objects
+ * returned by this method must be equal (using the {@code equals()}
* test).
*
* @param name
@@ -765,7 +765,7 @@ public interface Context {
* The caller should not make any changes to the object returned:
* their effect on the context is undefined.
* The environment of this context may be changed using
- * addToEnvironment() and removeFromEnvironment().
+ * {@code addToEnvironment()} and {@code removeFromEnvironment()}.
*
* @return the environment of this context; never null
* @throws NamingException if a naming exception is encountered
@@ -798,7 +798,7 @@ public interface Context {
* The string returned by this method is not a JNDI composite name
* and should not be passed directly to context methods.
* In naming systems for which the notion of full name does not
- * make sense, OperationNotSupportedException is thrown.
+ * make sense, {@code OperationNotSupportedException} is thrown.
*
* @return this context's name in its own namespace; never null
* @throws OperationNotSupportedException if the naming system does
@@ -821,7 +821,7 @@ public interface Context {
* passed to the initial context constructor,
* a system property, or an application resource file.
* If it is not specified in any of these sources,
- * NoInitialContextException is thrown when an initial
+ * {@code NoInitialContextException} is thrown when an initial
* context is required to complete an operation.
*
* The value of this constant is "java.naming.factory.initial".
@@ -882,7 +882,7 @@ public interface Context {
* a URL context factory.
* This property may be specified in the environment, a system property,
* or one or more resource files.
- * The prefix com.sun.jndi.url is always appended to
+ * The prefix {@code com.sun.jndi.url} is always appended to
* the possibly empty list of package prefixes.
*
* The value of this constant is "java.naming.factory.url.pkgs".
@@ -920,7 +920,7 @@ public interface Context {
* or a resource file.
* If it is not specified in any of these sources
* and the program attempts to use a JNDI URL containing a DNS name,
- * a ConfigurationException will be thrown.
+ * a {@code ConfigurationException} will be thrown.
*
* The value of this constant is "java.naming.dns.url".
*
@@ -974,7 +974,7 @@ public interface Context {
*
- * When a URL string (a String of the form
+ * When a URL string (a {@code String} of the form
* scheme_id:rest_of_name) is passed as a name parameter to
* any method, a URL context factory for handling that scheme is
* located and used to resolve the URL. If no such factory is found,
* the initial context specified by
- * "java.naming.factory.initial" is used. Similarly, when a
- * CompositeName object whose first component is a URL string is
+ * {@code "java.naming.factory.initial"} is used. Similarly, when a
+ * {@code CompositeName} object whose first component is a URL string is
* passed as a name parameter to any method, a URL context factory is
* located and used to resolve the first name component.
* See {@link NamingManager#getURLContext
- * NamingManager.getURLContext()} for a description of how URL
+ * NamingManager.getURLContext()} for a description of how URL
* context factories are located.
*
* This default policy of locating the initial context and URL context
* factories may be overridden
* by calling
- * NamingManager.setInitialContextFactoryBuilder().
+ * {@code NamingManager.setInitialContextFactoryBuilder()}.
*
* NoInitialContextException is thrown when an initial context cannot
* be instantiated. This exception can be thrown during any interaction
@@ -125,7 +125,7 @@ public class InitialContext implements Context {
/**
* The environment associated with this InitialContext.
* It is initialized to null and is updated by the constructor
- * that accepts an environment or by the init() method.
+ * that accepts an environment or by the {@code init()} method.
* @see #addToEnvironment
* @see #removeFromEnvironment
* @see #getEnvironment
@@ -152,14 +152,14 @@ public class InitialContext implements Context {
* Constructs an initial context with the option of not
* initializing it. This may be used by a constructor in
* a subclass when the value of the environment parameter
- * is not yet known at the time the InitialContext
+ * is not yet known at the time the {@code InitialContext}
* constructor is called. The subclass's constructor will
* call this constructor, compute the value of the environment,
- * and then call init() before returning.
+ * and then call {@code init()} before returning.
*
* @param lazy
* true means do not initialize the initial context; false
- * is equivalent to calling new InitialContext()
+ * is equivalent to calling {@code new InitialContext()}
* @throws NamingException if a naming exception is encountered
*
* @see #init(Hashtable)
@@ -174,7 +174,7 @@ public class InitialContext implements Context {
/**
* Constructs an initial context.
* No environment properties are supplied.
- * Equivalent to new InitialContext(null).
+ * Equivalent to {@code new InitialContext(null)}.
*
* @throws NamingException if a naming exception is encountered
*
@@ -188,10 +188,10 @@ public class InitialContext implements Context {
* Constructs an initial context using the supplied environment.
* Environment properties are discussed in the class description.
*
- * This constructor will not modify environment
+ * This constructor will not modify {@code environment}
* or save a reference to it, but may save a clone.
* Caller should not modify mutable keys and values in
- * environment after it has been passed to the constructor.
+ * {@code environment} after it has been passed to the constructor.
*
* @param environment
* environment used to create the initial context.
@@ -212,7 +212,7 @@ public class InitialContext implements Context {
* Initializes the initial context using the supplied environment.
* Environment properties are discussed in the class description.
*
- * This method will modify environment and save
+ * This method will modify {@code environment} and save
* a reference to it. The caller may no longer modify it.
*
* @param environment
@@ -245,7 +245,7 @@ public class InitialContext implements Context {
* InitialContext ic = new InitialContext();
* Object obj = ic.lookup();
*
- * If name is empty, returns a new instance of this context
+ * If {@code name} is empty, returns a new instance of this context
* (which represents the same naming context as this context, but its
* environment may be modified independently and it may be accessed
* concurrently).
@@ -253,7 +253,7 @@ public class InitialContext implements Context {
* @param
- * name is a composite name. If the intent is to set
+ * {@code name} is a composite name. If the intent is to set
* this field using a compound name or string, you must
* "stringify" the compound name, and create a composite
* name with a single component using the string. You can then
@@ -230,7 +230,7 @@ public class LinkException extends NamingException {
/**
* Sets the remaining link name field of this exception.
*
- * name is a composite name. If the intent is to set
+ * {@code name} is a composite name. If the intent is to set
* this field using a compound name or string, you must
* "stringify" the compound name, and create a composite
* name with a single component using the string. You can then
diff --git a/jdk/src/java.naming/share/classes/javax/naming/Name.java b/jdk/src/java.naming/share/classes/javax/naming/Name.java
index 7ec3231dc89..03a7c1bf0ea 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/Name.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/Name.java
@@ -28,12 +28,12 @@ package javax.naming;
import java.util.Enumeration;
/**
- * The Name interface represents a generic name -- an ordered
+ * The {@code Name} interface represents a generic name -- an ordered
* sequence of components. It can be a composite name (names that
* span multiple namespaces), or a compound name (names that are
* used within individual hierarchical naming systems).
*
- * There can be different implementations of Name; for example,
+ * There can be different implementations of {@code Name}; for example,
* composite names, URLs, or namespace-specific compound names.
*
* The components of a name are numbered. The indexes of a name
@@ -46,7 +46,7 @@ import java.util.Enumeration;
* value for a parameter that is a name or a name component.
* Likewise, methods that return a name or name component never return null.
*
- * An instance of a Name may not be synchronized against
+ * An instance of a {@code Name} may not be synchronized against
* concurrent multithreaded access if that access is not read-only.
*
* @author Rosanna Lee
@@ -82,7 +82,7 @@ public interface Name
* Returns a negative integer, zero, or a positive integer as this
* name is less than, equal to, or greater than the given name.
*
- * As with Object.equals(), the notion of ordering for names
+ * As with {@code Object.equals()}, the notion of ordering for names
* depends on the class that implements this interface.
* For example, the ordering may be
* based on lexicographical ordering of the name components.
@@ -93,7 +93,7 @@ public interface Name
* @param obj the non-null object to compare against.
* @return a negative integer, zero, or a positive integer as this name
* is less than, equal to, or greater than the given name
- * @throws ClassCastException if obj is not a Name of a
+ * @throws ClassCastException if obj is not a {@code Name} of a
* type that may be compared with this name
*
* @see Comparable#compareTo(Object)
@@ -170,23 +170,23 @@ public interface Name
/**
* Determines whether this name starts with a specified prefix.
- * A name n is a prefix if it is equal to
- * getPrefix(n.size()).
+ * A name {@code n} is a prefix if it is equal to
+ * {@code getPrefix(n.size())}.
*
* @param n
* the name to check
- * @return true if n is a prefix of this name, false otherwise
+ * @return true if {@code n} is a prefix of this name, false otherwise
*/
public boolean startsWith(Name n);
/**
* Determines whether this name ends with a specified suffix.
- * A name n is a suffix if it is equal to
- * getSuffix(size()-n.size()).
+ * A name {@code n} is a suffix if it is equal to
+ * {@code getSuffix(size()-n.size())}.
*
* @param n
* the name to check
- * @return true if n is a suffix of this name, false otherwise
+ * @return true if {@code n} is a suffix of this name, false otherwise
*/
public boolean endsWith(Name n);
@@ -197,7 +197,7 @@ public interface Name
* the components to add
* @return the updated name (not a new one)
*
- * @throws InvalidNameException if suffix is not a valid name,
+ * @throws InvalidNameException if {@code suffix} is not a valid name,
* or if the addition of the components would violate the syntax
* rules of this name
*/
@@ -219,7 +219,7 @@ public interface Name
*
* @throws ArrayIndexOutOfBoundsException
* if posn is outside the specified range
- * @throws InvalidNameException if n is not a valid name,
+ * @throws InvalidNameException if {@code n} is not a valid name,
* or if the addition of the components would violate the syntax
* rules of this name
*/
@@ -232,7 +232,7 @@ public interface Name
* the component to add
* @return the updated name (not a new one)
*
- * @throws InvalidNameException if adding comp would violate
+ * @throws InvalidNameException if adding {@code comp} would violate
* the syntax rules of this name
*/
public Name add(String comp) throws InvalidNameException;
@@ -252,7 +252,7 @@ public interface Name
*
* @throws ArrayIndexOutOfBoundsException
* if posn is outside the specified range
- * @throws InvalidNameException if adding comp would violate
+ * @throws InvalidNameException if adding {@code comp} would violate
* the syntax rules of this name
*/
public Name add(int posn, String comp) throws InvalidNameException;
diff --git a/jdk/src/java.naming/share/classes/javax/naming/NameClassPair.java b/jdk/src/java.naming/share/classes/javax/naming/NameClassPair.java
index 28b22004893..f69565afd2c 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/NameClassPair.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/NameClassPair.java
@@ -60,7 +60,7 @@ public class NameClassPair implements java.io.Serializable {
/**
* Contains the name of this NameClassPair.
* It is initialized by the constructor and can be updated using
- * setName().
+ * {@code setName()}.
* @serial
* @see #getName
* @see #setName
@@ -70,7 +70,7 @@ public class NameClassPair implements java.io.Serializable {
/**
*Contains the class name contained in this NameClassPair.
* It is initialized by the constructor and can be updated using
- * setClassName().
+ * {@code setClassName()}.
* @serial
* @see #getClassName
* @see #setClassName
@@ -80,7 +80,7 @@ public class NameClassPair implements java.io.Serializable {
/**
* Contains the full name of this NameClassPair within its
* own namespace.
- * It is initialized using setNameInNamespace()
+ * It is initialized using {@code setNameInNamespace()}
* @serial
* @see #getNameInNamespace
* @see #setNameInNamespace
@@ -89,10 +89,10 @@ public class NameClassPair implements java.io.Serializable {
/**
- * Records whether the name of this NameClassPair
+ * Records whether the name of this {@code NameClassPair}
* is relative to the target context.
* It is initialized by the constructor and can be updated using
- * setRelative().
+ * {@code setRelative()}.
* @serial
* @see #isRelative
* @see #setRelative
@@ -148,7 +148,7 @@ public class NameClassPair implements java.io.Serializable {
* Retrieves the class name of the object bound to the name of this binding.
* If a reference or some other indirect information is bound,
* retrieves the class name of the eventual object that
- * will be returned by Binding.getObject().
+ * will be returned by {@code Binding.getObject()}.
*
* @return The possibly null class name of object bound.
* It is null if the object bound is null.
@@ -162,10 +162,10 @@ public class NameClassPair implements java.io.Serializable {
/**
* Retrieves the name of this binding.
- * If isRelative() is true, this name is relative to the
+ * If {@code isRelative()} is true, this name is relative to the
* target context (which is named by the first parameter of the
- * list()).
- * If isRelative() is false, this name is a URL string.
+ * {@code list()}).
+ * If {@code isRelative()} is false, this name is a URL string.
*
* @return The non-null name of this binding.
* @see #isRelative
@@ -190,7 +190,7 @@ public class NameClassPair implements java.io.Serializable {
* Sets the class name of this binding.
*
* @param name the possibly null string to use as the class name.
- * If null, Binding.getClassName() will return
+ * If null, {@code Binding.getClassName()} will return
* the actual class name of the object in the binding.
* The class name will be null if the object bound is null.
* @see #getClassName
@@ -236,7 +236,7 @@ public class NameClassPair implements java.io.Serializable {
*
*
* In naming systems for which the notion of full name does not
- * apply to this binding an UnsupportedOperationException
+ * apply to this binding an {@code UnsupportedOperationException}
* is thrown.
* This exception is also thrown when a service provider written before
* the introduction of the method is in use.
@@ -261,11 +261,11 @@ public class NameClassPair implements java.io.Serializable {
/**
* Sets the full name of this binding.
* This method must be called to set the full name whenever a
- * NameClassPair is created and a full name is
+ * {@code NameClassPair} is created and a full name is
* applicable to this binding.
*
* Setting the full name to null, or not setting it at all, will
- * cause getNameInNamespace() to throw an exception.
+ * cause {@code getNameInNamespace()} to throw an exception.
*
* @param fullName The full name to use.
* @since 1.5
diff --git a/jdk/src/java.naming/share/classes/javax/naming/NamingEnumeration.java b/jdk/src/java.naming/share/classes/javax/naming/NamingEnumeration.java
index f40325e350d..b05260b2a1f 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/NamingEnumeration.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/NamingEnumeration.java
@@ -85,7 +85,7 @@ public interface NamingEnumeration
- * Note that next() can also throw the runtime exception
+ * Note that {@code next()} can also throw the runtime exception
* NoSuchElementException to indicate that the caller is
* attempting to enumerate beyond the end of the enumeration.
* This is different from a NamingException, which indicates
@@ -128,16 +128,16 @@ public interface NamingEnumeration
* This method indicates to the service provider that it is free
* to release resources associated with the enumeration, and can
- * notify servers to cancel any outstanding requests. The close()
+ * notify servers to cancel any outstanding requests. The {@code close()}
* method is a hint to implementations for managing their resources.
* Implementations are encouraged to use appropriate algorithms to
- * manage their resources when client omits the close() calls.
+ * manage their resources when client omits the {@code close()} calls.
*
* @exception NamingException If a naming exception is encountered
* while closing the enumeration.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/NamingException.java b/jdk/src/java.naming/share/classes/javax/naming/NamingException.java
index e1252da5f00..655cc86c9be 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/NamingException.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/NamingException.java
@@ -194,14 +194,14 @@ public class NamingException extends Exception {
/**
* Sets the resolved name field of this exception.
*
- * name is a composite name. If the intent is to set
+ * {@code name} is a composite name. If the intent is to set
* this field using a compound name or string, you must
* "stringify" the compound name, and create a composite
* name with a single component using the string. You can then
* invoke this method using the resulting composite name.
*
- * A copy of
- * name is a composite name. If the intent is to set
+ * {@code name} is a composite name. If the intent is to set
* this field using a compound name or string, you must
* "stringify" the compound name, and create a composite
* name with a single component using the string. You can then
* invoke this method using the resulting composite name.
*
- * A copy of
- * name is a composite name. If the intent is to append
+ * {@code name} is a composite name. If the intent is to append
* a compound name, you should "stringify" the compound name
* then invoke the overloaded form that accepts a String parameter.
*
- * Subsequent changes to
* This method predates the general-purpose exception chaining facility.
* The {@link #initCause(Throwable)} method is now the preferred means
@@ -348,10 +348,10 @@ public class NamingException extends Exception {
/**
* Returns the cause of this exception. The cause is the
* throwable that caused this naming exception to be thrown.
- * Returns
* A service provider provides
- * a subclass of ReferralException by providing implementations
- * for getReferralInfo() and getReferralContext() (and appropriate
+ * a subclass of {@code ReferralException} by providing implementations
+ * for {@code getReferralInfo()} and {@code getReferralContext()} (and appropriate
* constructors and/or corresponding "set" methods).
*
- * The following code sample shows how ReferralException can be used.
- *
- * ReferralException is an abstract class. Concrete implementations
+ * {@code ReferralException} is an abstract class. Concrete implementations
* determine its synchronization and serialization properties.
*
- * An environment parameter passed to the getReferralContext()
+ * An environment parameter passed to the {@code getReferralContext()}
* method is owned by the caller.
* The service provider will not modify the object or keep a reference to it,
* but may keep a reference to a clone of it.
@@ -114,7 +114,7 @@ public abstract class ReferralException extends NamingException {
*
* @return The non-null context at which to continue the method.
* @exception NamingException If a naming exception was encountered.
- * Call either retryReferral() or skipReferral()
+ * Call either {@code retryReferral()} or {@code skipReferral()}
* to continue processing referrals.
*/
public abstract Context getReferralContext() throws NamingException;
@@ -127,7 +127,7 @@ public abstract class ReferralException extends NamingException {
* enumeration, the referral exception should provide a context
* at which to continue the operation.
*
- * The referral context is created using env as its environment
+ * The referral context is created using {@code env} as its environment
* properties.
* This method should be used instead of the no-arg overloaded form
* when the caller needs to use different environment properties for
@@ -143,7 +143,7 @@ public abstract class ReferralException extends NamingException {
*
* @return The non-null context at which to continue the method.
* @exception NamingException If a naming exception was encountered.
- * Call either retryReferral() or skipReferral()
+ * Call either {@code retryReferral()} or {@code skipReferral()}
* to continue processing referrals.
*/
public abstract Context
@@ -153,7 +153,7 @@ public abstract class ReferralException extends NamingException {
/**
* Discards the referral about to be processed.
* A call to this method should be followed by a call to
- *
* In a directory, named objects can have associated with them
- * attributes. The Attribute interface represents an attribute associated
+ * attributes. The {@code Attribute} interface represents an attribute associated
* with a named object. An attribute contains 0 or more, possibly null, values.
- * The attribute values can be ordered or unordered (see isOrdered()).
+ * The attribute values can be ordered or unordered (see {@code isOrdered()}).
* If the values are unordered, no duplicates are allowed.
* If the values are ordered, duplicates are allowed.
*
* The content and representation of an attribute and its values is defined by
* the attribute's schema. The schema contains information
* about the attribute's syntax and other properties about the attribute.
- * See getAttributeDefinition() and
- * getAttributeSyntaxDefinition()
+ * See {@code getAttributeDefinition()} and
+ * {@code getAttributeSyntaxDefinition()}
* for details regarding how to get schema information about an attribute
* if the underlying directory service supports schemas.
*
* Equality of two attributes is determined by the implementation class.
- * A simple implementation can use Object.equals() to determine equality
+ * A simple implementation can use {@code Object.equals()} to determine equality
* of attribute values, while a more sophisticated implementation might
* make use of schema information to determine equality.
* Similarly, one implementation might provide a static storage
* structure which simply returns the values passed to its
- * constructor, while another implementation might define get() and
- * getAll().
+ * constructor, while another implementation might define {@code get()} and
+ * {@code getAll()}.
* to get the values dynamically from the directory.
*
- * Note that updates to Attribute (such as adding or removing a
+ * Note that updates to {@code Attribute} (such as adding or removing a
* value) do not affect the corresponding representation of the attribute
* in the directory. Updates to the directory can only be effected
- * using operations in the DirContext interface.
+ * using operations in the {@code DirContext} interface.
*
* @author Rosanna Lee
* @author Scott Seligman
@@ -129,7 +129,7 @@ public interface Attribute extends Cloneable, java.io.Serializable {
/**
* Determines whether a value is in the attribute.
* Equality is determined by the implementation, which may use
- * Object.equals() or schema information to determine equality.
+ * {@code Object.equals()} or schema information to determine equality.
*
* @param attrVal The possibly null value to check. If null, check
* whether the attribute has an attribute value whose value is null.
@@ -141,12 +141,12 @@ public interface Attribute extends Cloneable, java.io.Serializable {
/**
* Adds a new value to the attribute.
* If the attribute values are unordered and
- * attrVal is already in the attribute, this method does nothing.
- * If the attribute values are ordered, attrVal is added to the end of
+ * {@code attrVal} is already in the attribute, this method does nothing.
+ * If the attribute values are ordered, {@code attrVal} is added to the end of
* the list of attribute values.
*
* Equality is determined by the implementation, which may use
- * Object.equals() or schema information to determine equality.
+ * {@code Object.equals()} or schema information to determine equality.
*
* @param attrVal The new possibly null value to add. If null, null
* is added as an attribute value.
@@ -156,15 +156,15 @@ public interface Attribute extends Cloneable, java.io.Serializable {
/**
* Removes a specified value from the attribute.
- * If attrval is not in the attribute, this method does nothing.
+ * If {@code attrval} is not in the attribute, this method does nothing.
* If the attribute values are ordered, the first occurrence of
- * attrVal is removed and attribute values at indices greater
+ * {@code attrVal} is removed and attribute values at indices greater
* than the removed
* value are shifted up towards the head of the list (and their indices
* decremented by one).
*
* Equality is determined by the implementation, which may use
- * Object.equals() or schema information to determine equality.
+ * {@code Object.equals()} or schema information to determine equality.
*
* @param attrval The possibly null value to remove from this attribute.
* If null, remove the attribute value that is null.
@@ -260,66 +260,66 @@ public interface Attribute extends Cloneable, java.io.Serializable {
/**
* Retrieves the attribute value from the ordered list of attribute values.
- * This method returns the value at the ix index of the list of
+ * This method returns the value at the {@code ix} index of the list of
* attribute values.
* If the attribute values are unordered,
* this method returns the value that happens to be at that index.
* @param ix The index of the value in the ordered list of attribute values.
* {@code 0 <= ix < size()}.
- * @return The possibly null attribute value at index ix;
+ * @return The possibly null attribute value at index {@code ix};
* null if the attribute value is null.
* @exception NamingException If a naming exception was encountered while
* retrieving the value.
- * @exception IndexOutOfBoundsException If ix is outside the specified range.
+ * @exception IndexOutOfBoundsException If {@code ix} is outside the specified range.
*/
Object get(int ix) throws NamingException;
/**
* Removes an attribute value from the ordered list of attribute values.
- * This method removes the value at the ix index of the list of
+ * This method removes the value at the {@code ix} index of the list of
* attribute values.
* If the attribute values are unordered,
* this method removes the value that happens to be at that index.
- * Values located at indices greater than ix are shifted up towards
+ * Values located at indices greater than {@code ix} are shifted up towards
* the front of the list (and their indices decremented by one).
*
* @param ix The index of the value to remove.
* {@code 0 <= ix < size()}.
- * @return The possibly null attribute value at index ix that was removed;
+ * @return The possibly null attribute value at index {@code ix} that was removed;
* null if the attribute value is null.
- * @exception IndexOutOfBoundsException If ix is outside the specified range.
+ * @exception IndexOutOfBoundsException If {@code ix} is outside the specified range.
*/
Object remove(int ix);
/**
* Adds an attribute value to the ordered list of attribute values.
- * This method adds attrVal to the list of attribute values at
- * index ix.
- * Values located at indices at or greater than ix are
+ * This method adds {@code attrVal} to the list of attribute values at
+ * index {@code ix}.
+ * Values located at indices at or greater than {@code ix} are
* shifted down towards the end of the list (and their indices incremented
* by one).
- * If the attribute values are unordered and already have attrVal,
- * IllegalStateException is thrown.
+ * If the attribute values are unordered and already have {@code attrVal},
+ * {@code IllegalStateException} is thrown.
*
* @param ix The index in the ordered list of attribute values to add the new value.
* {@code 0 <= ix <= size()}.
* @param attrVal The possibly null attribute value to add; if null, null is
* the value added.
- * @exception IndexOutOfBoundsException If ix is outside the specified range.
+ * @exception IndexOutOfBoundsException If {@code ix} is outside the specified range.
* @exception IllegalStateException If the attribute values are unordered and
- * attrVal is one of those values.
+ * {@code attrVal} is one of those values.
*/
void add(int ix, Object attrVal);
/**
* Sets an attribute value in the ordered list of attribute values.
- * This method sets the value at the ix index of the list of
- * attribute values to be attrVal. The old value is removed.
+ * This method sets the value at the {@code ix} index of the list of
+ * attribute values to be {@code attrVal}. The old value is removed.
* If the attribute values are unordered,
* this method sets the value that happens to be at that index
- * to attrVal, unless attrVal is already one of the values.
- * In that case, IllegalStateException is thrown.
+ * to {@code attrVal}, unless {@code attrVal} is already one of the values.
+ * In that case, {@code IllegalStateException} is thrown.
*
* @param ix The index of the value in the ordered list of attribute values.
* {@code 0 <= ix < size()}.
@@ -327,8 +327,8 @@ public interface Attribute extends Cloneable, java.io.Serializable {
* If null, 'null' replaces the old value.
* @return The possibly null attribute value at index ix that was replaced.
* Null if the attribute value was null.
- * @exception IndexOutOfBoundsException If ix is outside the specified range.
- * @exception IllegalStateException If attrVal already exists and the
+ * @exception IndexOutOfBoundsException If {@code ix} is outside the specified range.
+ * @exception IllegalStateException If {@code attrVal} already exists and the
* attribute values are unordered.
*/
Object set(int ix, Object attrVal);
diff --git a/jdk/src/java.naming/share/classes/javax/naming/directory/Attributes.java b/jdk/src/java.naming/share/classes/javax/naming/directory/Attributes.java
index b54549a0934..3273b1ed1cb 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/directory/Attributes.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/directory/Attributes.java
@@ -103,7 +103,7 @@ public interface Attributes extends Cloneable, java.io.Serializable {
* are undefined.
*
* @return A non-null enumeration of the attributes in this attribute set.
- * Each element of the enumeration is of class Attribute.
+ * Each element of the enumeration is of class {@code Attribute}.
* If attribute set has zero attributes, an empty enumeration
* is returned.
*/
diff --git a/jdk/src/java.naming/share/classes/javax/naming/directory/BasicAttribute.java b/jdk/src/java.naming/share/classes/javax/naming/directory/BasicAttribute.java
index eb817e4a4d6..41ab9184452 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/directory/BasicAttribute.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/directory/BasicAttribute.java
@@ -35,35 +35,35 @@ import javax.naming.NamingEnumeration;
import javax.naming.OperationNotSupportedException;
/**
- * This class provides a basic implementation of the Attribute interface.
+ * This class provides a basic implementation of the {@code Attribute} interface.
*
* This implementation does not support the schema methods
- * getAttributeDefinition() and getAttributeSyntaxDefinition().
- * They simply throw OperationNotSupportedException.
- * Subclasses of BasicAttribute should override these methods if they
+ * {@code getAttributeDefinition()} and {@code getAttributeSyntaxDefinition()}.
+ * They simply throw {@code OperationNotSupportedException}.
+ * Subclasses of {@code BasicAttribute} should override these methods if they
* support them.
*
- * The BasicAttribute class by default uses Object.equals() to
+ * The {@code BasicAttribute} class by default uses {@code Object.equals()} to
* determine equality of attribute values when testing for equality or
* when searching for values, except when the value is an array.
- * For an array, each element of the array is checked using Object.equals().
- * Subclasses of BasicAttribute can make use of schema information
+ * For an array, each element of the array is checked using {@code Object.equals()}.
+ * Subclasses of {@code BasicAttribute} can make use of schema information
* when doing similar equality checks by overriding methods
* in which such use of schema is meaningful.
- * Similarly, the BasicAttribute class by default returns the values passed to its
+ * Similarly, the {@code BasicAttribute} class by default returns the values passed to its
* constructor and/or manipulated using the add/remove methods.
- * Subclasses of BasicAttribute can override get() and getAll()
+ * Subclasses of {@code BasicAttribute} can override {@code get()} and {@code getAll()}
* to get the values dynamically from the directory (or implement
- * the Attribute interface directly instead of subclassing BasicAttribute).
+ * the {@code Attribute} interface directly instead of subclassing {@code BasicAttribute}).
*
- * Note that updates to BasicAttribute (such as adding or removing a value)
+ * Note that updates to {@code BasicAttribute} (such as adding or removing a value)
* does not affect the corresponding representation of the attribute
* in the directory. Updates to the directory can only be effected
- * using operations in the DirContext interface.
+ * using operations in the {@code DirContext} interface.
*
- * A BasicAttribute instance is not synchronized against concurrent
+ * A {@code BasicAttribute} instance is not synchronized against concurrent
* multithreaded access. Multiple threads trying to access and modify a
- * BasicAttribute should lock the object.
+ * {@code BasicAttribute} should lock the object.
*
* @author Rosanna Lee
* @author Scott Seligman
@@ -112,16 +112,16 @@ public class BasicAttribute implements Attribute {
* order the values must match.
* If obj is null or not an Attribute, false is returned.
*
- * By default Object.equals() is used when comparing the attribute
+ * By default {@code Object.equals()} is used when comparing the attribute
* id and its values except when a value is an array. For an array,
- * each element of the array is checked using Object.equals().
+ * each element of the array is checked using {@code Object.equals()}.
* A subclass may override this to make
* use of schema syntax information and matching rules,
* which define what it means for two attributes to be equal.
* How and whether a subclass makes
* use of the schema information is determined by the subclass.
- * If a subclass overrides equals(), it should also override
- * hashCode()
+ * If a subclass overrides {@code equals()}, it should also override
+ * {@code hashCode()}
* such that two attributes that are equal have the same hash code.
*
* @param obj The possibly null object to check.
@@ -172,8 +172,8 @@ public class BasicAttribute implements Attribute {
* the attribute's id and that of all of its values except for
* values that are arrays.
* For an array, the hash code of each element of the array is summed.
- * If a subclass overrides hashCode(), it should override
- * equals()
+ * If a subclass overrides {@code hashCode()}, it should override
+ * {@code equals()}
* as well so that two attributes that are equal have the same hash code.
*
* @return an int representing the hash code of this attribute.
@@ -315,10 +315,10 @@ public class BasicAttribute implements Attribute {
* Determines whether a value is in this attribute.
*
* By default,
- * Object.equals() is used when comparing attrVal
- * with this attribute's values except when attrVal is an array.
+ * {@code Object.equals()} is used when comparing {@code attrVal}
+ * with this attribute's values except when {@code attrVal} is an array.
* For an array, each element of the array is checked using
- * Object.equals().
+ * {@code Object.equals()}.
* A subclass may use schema information to determine equality.
*/
public boolean contains(Object attrVal) {
@@ -352,7 +352,7 @@ public class BasicAttribute implements Attribute {
/**
* Determines whether two attribute values are equal.
- * Use arrayEquals for arrays and Object.equals() otherwise.
+ * Use arrayEquals for arrays and {@code Object.equals()} otherwise.
*/
private static boolean valueEquals(Object obj1, Object obj2) {
if (obj1 == obj2) {
@@ -370,7 +370,7 @@ public class BasicAttribute implements Attribute {
/**
* Determines whether two arrays are equal by comparing each of their
- * elements using Object.equals().
+ * elements using {@code Object.equals()}.
*/
private static boolean arrayEquals(Object a1, Object a2) {
int len;
@@ -393,10 +393,10 @@ public class BasicAttribute implements Attribute {
/**
* Adds a new value to this attribute.
*
- * By default, Object.equals() is used when comparing attrVal
- * with this attribute's values except when attrVal is an array.
+ * By default, {@code Object.equals()} is used when comparing {@code attrVal}
+ * with this attribute's values except when {@code attrVal} is an array.
* For an array, each element of the array is checked using
- * Object.equals().
+ * {@code Object.equals()}.
* A subclass may use schema information to determine equality.
*/
public boolean add(Object attrVal) {
@@ -411,10 +411,10 @@ public class BasicAttribute implements Attribute {
/**
* Removes a specified value from this attribute.
*
- * By default, Object.equals() is used when comparing attrVal
- * with this attribute's values except when attrVal is an array.
+ * By default, {@code Object.equals()} is used when comparing {@code attrVal}
+ * with this attribute's values except when {@code attrVal} is an array.
* For an array, each element of the array is checked using
- * Object.equals().
+ * {@code Object.equals()}.
* A subclass may use schema information to determine equality.
*/
public boolean remove(Object attrval) {
diff --git a/jdk/src/java.naming/share/classes/javax/naming/directory/BasicAttributes.java b/jdk/src/java.naming/share/classes/javax/naming/directory/BasicAttributes.java
index 70ed5f4655a..0b8178c91cd 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/directory/BasicAttributes.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/directory/BasicAttributes.java
@@ -207,17 +207,17 @@ public class BasicAttributes implements Attributes {
}
/**
- * Determines whether this BasicAttributes is equal to another
- * Attributes
- * Two Attributes are equal if they are both instances of
- * Attributes,
+ * Determines whether this {@code BasicAttributes} is equal to another
+ * {@code Attributes}
+ * Two {@code Attributes} are equal if they are both instances of
+ * {@code Attributes},
* treat the case of attribute IDs the same way, and contain the
- * same attributes. Each Attribute in this BasicAttributes
- * is checked for equality using Object.equals(), which may have
- * be overridden by implementations of Attribute).
- * If a subclass overrides equals(),
- * it should override hashCode()
- * as well so that two Attributes instances that are equal
+ * same attributes. Each {@code Attribute} in this {@code BasicAttributes}
+ * is checked for equality using {@code Object.equals()}, which may have
+ * be overridden by implementations of {@code Attribute}).
+ * If a subclass overrides {@code equals()},
+ * it should override {@code hashCode()}
+ * as well so that two {@code Attributes} instances that are equal
* have the same hash code.
* @param obj the possibly null object to compare against.
*
@@ -259,9 +259,9 @@ public class BasicAttributes implements Attributes {
* The hash code is computed by adding the hash code of
* the attributes of this object. If this BasicAttributes
* ignores case of its attribute IDs, one is added to the hash code.
- * If a subclass overrides hashCode(),
- * it should override equals()
- * as well so that two Attributes instances that are equal
+ * If a subclass overrides {@code hashCode()},
+ * it should override {@code equals()}
+ * as well so that two {@code Attributes} instances that are equal
* have the same hash code.
*
* @return an int representing the hash code of this BasicAttributes instance.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/directory/DirContext.java b/jdk/src/java.naming/share/classes/javax/naming/directory/DirContext.java
index 2b77486673a..5eb4b186891 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/directory/DirContext.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/directory/DirContext.java
@@ -33,7 +33,7 @@ import javax.naming.*;
* associated with objects, and for searching the directory.
*
*
@@ -47,9 +47,9 @@ import javax.naming.*;
* The second version instead has a link to the first: the same
* documentation applies to both.
*
- * See Context for a discussion on the interpretation of the
- * name argument to the Context methods. These same rules
- * apply to the name argument to the DirContext methods.
+ * See {@code Context} for a discussion on the interpretation of the
+ * name argument to the {@code Context} methods. These same rules
+ * apply to the name argument to the {@code DirContext} methods.
*
*
- * In the getAttributes() and search() methods,
+ * In the {@code getAttributes()} and {@code search()} methods,
* you can specify that all attributes associated with the requested objects
- * be returned by supply null as the list of attributes to return.
+ * be returned by supply {@code null} as the list of attributes to return.
* The attributes returned do not include operational attributes.
* In order to retrieve operational attributes, you must name them explicitly.
*
@@ -140,13 +140,13 @@ import javax.naming.*;
*
*
- * An Attributes, SearchControls, or array object
+ * An {@code Attributes}, {@code SearchControls}, or array object
* passed as a parameter to any method will not be modified by the
* service provider. The service provider may keep a reference to it
* for the duration of the operation, including any enumeration of the
* method's results and the processing of any referrals generated.
* The caller should not modify the object during this time.
- * An Attributes object returned by any method is owned by
+ * An {@code Attributes} object returned by any method is owned by
* the caller. The caller may subsequently modify it; the service
* provider will not.
*
@@ -254,7 +254,7 @@ public interface DirContext extends Context {
* If attempting to add more than one value to a single-valued attribute,
* throws
- * The value of this constant is 1.
+ * The value of this constant is {@code 1}.
*
* @see ModificationItem
* @see #modifyAttributes
@@ -273,7 +273,7 @@ public interface DirContext extends Context {
* attempting to add more than one value to a single-valued attribute,
* throws
- * The value of this constant is 2.
+ * The value of this constant is {@code 2}.
*
* @see ModificationItem
* @see #modifyAttributes
@@ -294,7 +294,7 @@ public interface DirContext extends Context {
* Removal of the last value will remove the attribute if the
* attribute is required to have at least one value.
*
- * The value of this constant is 3.
+ * The value of this constant is {@code 3}.
*
* @see ModificationItem
* @see #modifyAttributes
@@ -391,12 +391,12 @@ public interface DirContext extends Context {
/**
* Binds a name to an object, along with associated attributes.
- * If attrs is null, the resulting binding will have
- * the attributes associated with obj if obj is a
- * DirContext, and no attributes otherwise.
- * If attrs is non-null, the resulting binding will have
- * attrs as its attributes; any attributes associated with
- * obj are ignored.
+ * If {@code attrs} is null, the resulting binding will have
+ * the attributes associated with {@code obj} if {@code obj} is a
+ * {@code DirContext}, and no attributes otherwise.
+ * If {@code attrs} is non-null, the resulting binding will have
+ * {@code attrs} as its attributes; any attributes associated with
+ * {@code obj} are ignored.
*
* @param name
* the name to bind; may not be empty
@@ -438,16 +438,16 @@ public interface DirContext extends Context {
/**
* Binds a name to an object, along with associated attributes,
* overwriting any existing binding.
- * If attrs is null and obj is a DirContext,
- * the attributes from obj are used.
- * If attrs is null and obj is not a DirContext,
+ * If {@code attrs} is null and {@code obj} is a {@code DirContext},
+ * the attributes from {@code obj} are used.
+ * If {@code attrs} is null and {@code obj} is not a {@code DirContext},
* any existing attributes associated with the object already bound
* in the directory remain unchanged.
- * If attrs is non-null, any existing attributes associated with
- * the object already bound in the directory are removed and attrs
- * is associated with the named object. If obj is a
- * DirContext and attrs is non-null, the attributes
- * of obj are ignored.
+ * If {@code attrs} is non-null, any existing attributes associated with
+ * the object already bound in the directory are removed and {@code attrs}
+ * is associated with the named object. If {@code obj} is a
+ * {@code DirContext} and {@code attrs} is non-null, the attributes
+ * of {@code obj} are ignored.
*
* @param name
* the name to bind; may not be empty
@@ -492,8 +492,8 @@ public interface DirContext extends Context {
* component of the name), and associates the supplied attributes
* with the newly created object.
* All intermediate and target contexts must already exist.
- * If attrs is null, this method is equivalent to
- * Context.createSubcontext().
+ * If {@code attrs} is null, this method is equivalent to
+ * {@code Context.createSubcontext()}.
*
* @param name
* the name of the context to create; may not be empty
@@ -579,8 +579,8 @@ public interface DirContext extends Context {
* "object class" being referred to here is in the directory sense
* rather than in the Java sense.
* For example, if the named object is a directory object of
- * "Person" class, getSchemaClassDefinition() would return a
- * DirContext representing the (directory's) object class
+ * "Person" class, {@code getSchemaClassDefinition()} would return a
+ * {@code DirContext} representing the (directory's) object class
* definition of "Person".
*
* The information that can be retrieved from an object class definition
@@ -589,13 +589,13 @@ public interface DirContext extends Context {
* Prior to JNDI 1.2, this method
* returned a single schema object representing the class definition of
* the named object.
- * Since JNDI 1.2, this method returns a DirContext containing
+ * Since JNDI 1.2, this method returns a {@code DirContext} containing
* all of the named object's class definitions.
*
* @param name
* the name of the object whose object class
* definition is to be retrieved
- * @return the DirContext containing the named
+ * @return the {@code DirContext} containing the named
* object's class definitions; never null
*
* @throws OperationNotSupportedException if schema not supported
@@ -612,7 +612,7 @@ public interface DirContext extends Context {
* @param name
* the name of the object whose object class
* definition is to be retrieved
- * @return the DirContext containing the named
+ * @return the {@code DirContext} containing the named
* object's class definitions; never null
*
* @throws OperationNotSupportedException if schema not supported
@@ -656,7 +656,7 @@ public interface DirContext extends Context {
* substring comparison) use the version of the
- * When changes are made to this DirContext,
+ * When changes are made to this {@code DirContext},
* the effect on enumerations returned by prior calls to this method
* is undefined.
*
@@ -681,8 +681,8 @@ public interface DirContext extends Context {
* all attributes are to be returned;
* an empty array indicates that none are to be returned.
* @return
- * a non-null enumeration of SearchResult objects.
- * Each SearchResult contains the attributes
+ * a non-null enumeration of {@code SearchResult} objects.
+ * Each {@code SearchResult} contains the attributes
* identified by
- * The result is returned in an enumeration of SearchResults.
- * Each SearchResult contains the name of the object
+ * The result is returned in an enumeration of {@code SearchResult}s.
+ * Each {@code SearchResult} contains the name of the object
* and other information about the object (see SearchResult).
* The name is either relative to the target context of the search
* (which is named by the
* If the object does not have a requested attribute, that
@@ -839,8 +839,8 @@ public interface DirContext extends Context {
* @param cons
* the search controls that control the search. If null,
* the default search controls are used (equivalent
- * to (new SearchControls())).
- * @return an enumeration of SearchResults of
+ * to {@code (new SearchControls())}).
+ * @return an enumeration of {@code SearchResult}s of
* the objects that satisfy the filter; never null
*
* @throws InvalidSearchFilterException if the search filter specified is
@@ -872,9 +872,9 @@ public interface DirContext extends Context {
* @param cons
* the search controls that control the search. If null,
* the default search controls are used (equivalent
- * to (new SearchControls())).
+ * to {@code (new SearchControls())}).
*
- * @return an enumeration of SearchResults for
+ * @return an enumeration of {@code SearchResult}s for
* the objects that satisfy the filter.
* @throws InvalidSearchFilterException if the search filter specified is
* not supported or understood by the underlying directory
@@ -935,8 +935,8 @@ public interface DirContext extends Context {
*
- * The SearchResult may also contain attributes of the matching
- * object if the cons argument specifies that attributes be
+ * The {@code SearchResult} may also contain attributes of the matching
+ * object if the {@code cons} argument specifies that attributes be
* returned.
*
* If the object does not have a requested attribute, that
@@ -972,17 +972,17 @@ public interface DirContext extends Context {
* @param cons
* the search controls that control the search. If null,
* the default search controls are used (equivalent
- * to (new SearchControls())).
- * @return an enumeration of SearchResults of the objects
+ * to {@code (new SearchControls())}).
+ * @return an enumeration of {@code SearchResult}s of the objects
* that satisfy the filter; never null
*
- * @throws ArrayIndexOutOfBoundsException if filterExpr contains
+ * @throws ArrayIndexOutOfBoundsException if {@code filterExpr} contains
* This constructor will not modify environment
+ * This constructor will not modify {@code environment}
* or save a reference to it, but may save a clone.
* Caller should not modify mutable keys and values in
- * environment after it has been passed to the constructor.
+ * {@code environment} after it has been passed to the constructor.
*
* @param environment
* environment used to create the initial DirContext.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/directory/SearchControls.java b/jdk/src/java.naming/share/classes/javax/naming/directory/SearchControls.java
index ec4deb14efa..a08e454e289 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/directory/SearchControls.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/directory/SearchControls.java
@@ -54,7 +54,7 @@ public class SearchControls implements java.io.Serializable {
* It contains zero element if the named object does not satisfy
* the search filter specified in search().
*
- * The value of this constant is 0.
+ * The value of this constant is {@code 0}.
*/
public final static int OBJECT_SCOPE = 0;
@@ -68,7 +68,7 @@ public class SearchControls implements java.io.Serializable {
* The names of elements in the NamingEnumeration are atomic names
* relative to the named context.
*
- * The value of this constant is 1.
+ * The value of this constant is {@code 1}.
*/
public final static int ONELEVEL_SCOPE = 1;
/**
@@ -90,14 +90,14 @@ public class SearchControls implements java.io.Serializable {
* included in the enumeration with the empty string as
* its name.
*
- * The value of this constant is 2.
+ * The value of this constant is {@code 2}.
*/
public final static int SUBTREE_SCOPE = 2;
/**
* Contains the scope with which to apply the search. One of
- * ONELEVEL_SCOPE, OBJECT_SCOPE, or
- * SUBTREE_SCOPE.
+ * {@code ONELEVEL_SCOPE}, {@code OBJECT_SCOPE}, or
+ * {@code SUBTREE_SCOPE}.
* @serial
*/
private int searchScope;
@@ -117,7 +117,7 @@ public class SearchControls implements java.io.Serializable {
private boolean derefLink;
/**
- * Indicates whether object is returned in SearchResult.
+ * Indicates whether object is returned in {@code SearchResult}.
* @serial
*/
private boolean returnObj;
@@ -130,7 +130,7 @@ public class SearchControls implements java.io.Serializable {
/**
* Contains the list of attributes to be returned in
- * SearchResult for each matching entry of search. null
+ * {@code SearchResult} for each matching entry of search. {@code null}
* indicates that all attributes are to be returned.
* @serial
*/
diff --git a/jdk/src/java.naming/share/classes/javax/naming/directory/SearchResult.java b/jdk/src/java.naming/share/classes/javax/naming/directory/SearchResult.java
index 624b9fc89c6..3217e6b55fe 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/directory/SearchResult.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/directory/SearchResult.java
@@ -53,9 +53,9 @@ public class SearchResult extends Binding {
* Constructs a search result using the result's name, its bound object, and
* its attributes.
*
- * getClassName() will return the class name of obj
- * (or null if obj is null) unless the class name has been
- * explicitly set using setClassName().
+ * {@code getClassName()} will return the class name of {@code obj}
+ * (or null if {@code obj} is null) unless the class name has been
+ * explicitly set using {@code setClassName()}.
*
* @param name The non-null name of the search item. It is relative
* to the target context of the search (which is
@@ -76,9 +76,9 @@ public class SearchResult extends Binding {
* Constructs a search result using the result's name, its bound object, and
* its attributes, and whether the name is relative.
*
- * getClassName() will return the class name of obj
- * (or null if obj is null) unless the class name has been
- * explicitly set using setClassName()
+ * {@code getClassName()} will return the class name of {@code obj}
+ * (or null if {@code obj} is null) unless the class name has been
+ * explicitly set using {@code setClassName()}
*
* @param name The non-null name of the search item.
* @param obj The object bound to name. Can be null.
@@ -106,9 +106,9 @@ public class SearchResult extends Binding {
* named by the first parameter of the
@@ -47,20 +47,20 @@ objects using specified attributes.
-You use getAttributes() to retrieve the attributes
+You use
-DirContext also behaves as a naming context
-by extending the Context interface in the javax.naming package.
+
* If a service only supports registration for existing
* targets, an attempt to register for a nonexistent target
- * results in a NameNotFoundException being thrown as early as possible,
- * preferably at the time addNamingListener() is called, or if that is
+ * results in a {@code NameNotFoundException} being thrown as early as possible,
+ * preferably at the time {@code addNamingListener()} is called, or if that is
* not possible, the listener will receive the exception through the
- * NamingExceptionEvent.
+ * {@code NamingExceptionEvent}.
*
* Also, for service providers that only support registration for existing
* targets, when the target that a listener has registered for is
* subsequently removed from the namespace, the listener is notified
- * via a NamingExceptionEvent (containing a
- *NameNotFoundException).
+ * via a {@code NamingExceptionEvent} (containing a
+ *{@code NameNotFoundException}).
*
- * An application can use the method targetMustExist() to check
- * whether a EventContext supports registration
+ * An application can use the method {@code targetMustExist()} to check
+ * whether a {@code EventContext} supports registration
* of nonexistent targets.
*
*
* For example, suppose a listener makes the following registration:
@@ -78,52 +78,52 @@ import javax.naming.NamingException;
* src.addNamingListener("x", SUBTREE_SCOPE, listener);
*
* Furthermore, listener registration/deregistration is with
- * the EventContext
+ * the {@code EventContext}
* instance, and not with the corresponding object in the namespace.
* If the program intends at some point to remove a listener, then it needs to
- * keep a reference to the EventContext instance on
- * which it invoked addNamingListener() (just as
+ * keep a reference to the {@code EventContext} instance on
+ * which it invoked {@code addNamingListener()} (just as
* it needs to keep a reference to the listener in order to remove it
- * later). It cannot expect to do a lookup() and get another instance of
- * a EventContext on which to perform the deregistration.
+ * later). It cannot expect to do a {@code lookup()} and get another instance of
+ * a {@code EventContext} on which to perform the deregistration.
*
- * The value of this constant is 0.
+ * The value of this constant is {@code 0}.
*/
public final static int OBJECT_SCOPE = 0;
@@ -147,7 +147,7 @@ public interface EventContext extends Context {
* in the context named by the target,
* excluding the context named by the target.
*
- * The value of this constant is 1.
+ * The value of this constant is {@code 1}.
*/
public final static int ONELEVEL_SCOPE = 1;
@@ -156,7 +156,7 @@ public interface EventContext extends Context {
* in the subtree of the object named by the target, including the object
* named by the target.
*
- * The value of this constant is 2.
+ * The value of this constant is {@code 2}.
*/
public final static int SUBTREE_SCOPE = 2;
@@ -167,31 +167,31 @@ public interface EventContext extends Context {
*
* The event source of those events is this context. See the
* class description for a discussion on event source and target.
- * See the descriptions of the constants OBJECT_SCOPE,
- * ONELEVEL_SCOPE, and SUBTREE_SCOPE to see how
- * scope affects the registration.
+ * See the descriptions of the constants {@code OBJECT_SCOPE},
+ * {@code ONELEVEL_SCOPE}, and {@code SUBTREE_SCOPE} to see how
+ * {@code scope} affects the registration.
*
- * target needs to name a context only when scope is
- * ONELEVEL_SCOPE.
- * target may name a non-context if scope is either
- * OBJECT_SCOPE or SUBTREE_SCOPE. Using
- * SUBTREE_SCOPE for a non-context might be useful,
- * for example, if the caller does not know in advance whether target
+ * {@code target} needs to name a context only when {@code scope} is
+ * {@code ONELEVEL_SCOPE}.
+ * {@code target} may name a non-context if {@code scope} is either
+ * {@code OBJECT_SCOPE} or {@code SUBTREE_SCOPE}. Using
+ * {@code SUBTREE_SCOPE} for a non-context might be useful,
+ * for example, if the caller does not know in advance whether {@code target}
* is a context and just wants to register interest in the (possibly
- * degenerate subtree) rooted at target.
+ * degenerate subtree) rooted at {@code target}.
*
* When the listener is notified of an event, the listener may
* in invoked in a thread other than the one in which
- * addNamingListener() is executed.
+ * {@code addNamingListener()} is executed.
* Care must be taken when multiple threads are accessing the same
- * EventContext concurrently.
+ * {@code EventContext} concurrently.
* See the
* package description
* for more information on threading issues.
*
* @param target A nonnull name to be resolved relative to this context.
- * @param scope One of OBJECT_SCOPE, ONELEVEL_SCOPE, or
- * SUBTREE_SCOPE.
+ * @param scope One of {@code OBJECT_SCOPE}, {@code ONELEVEL_SCOPE}, or
+ * {@code SUBTREE_SCOPE}.
* @param l The nonnull listener.
* @exception NamingException If a problem was encountered while
* adding the listener.
@@ -204,12 +204,12 @@ public interface EventContext extends Context {
* Adds a listener for receiving naming events fired
* when the object named by the string target name and scope changes.
*
- * See the overload that accepts a Name for details.
+ * See the overload that accepts a {@code Name} for details.
*
* @param target The nonnull string name of the object resolved relative
* to this context.
- * @param scope One of OBJECT_SCOPE, ONELEVEL_SCOPE, or
- * SUBTREE_SCOPE.
+ * @param scope One of {@code OBJECT_SCOPE}, {@code ONELEVEL_SCOPE}, or
+ * {@code SUBTREE_SCOPE}.
* @param l The nonnull listener.
* @exception NamingException If a problem was encountered while
* adding the listener.
@@ -220,15 +220,15 @@ public interface EventContext extends Context {
/**
* Removes a listener from receiving naming events fired
- * by this EventContext.
+ * by this {@code EventContext}.
* The listener may have registered more than once with this
- * EventContext, perhaps with different target/scope arguments.
+ * {@code EventContext}, perhaps with different target/scope arguments.
* After this method is invoked, the listener will no longer
- * receive events with this EventContext instance
+ * receive events with this {@code EventContext} instance
* as the event source (except for those events already in the process of
* being dispatched).
* If the listener was not, or is no longer, registered with
- * this EventContext instance, this method does not do anything.
+ * this {@code EventContext} instance, this method does not do anything.
*
* @param l The nonnull listener.
* @exception NamingException If a problem was encountered while
diff --git a/jdk/src/java.naming/share/classes/javax/naming/event/EventDirContext.java b/jdk/src/java.naming/share/classes/javax/naming/event/EventDirContext.java
index 86defa1b099..8be88144157 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/event/EventDirContext.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/event/EventDirContext.java
@@ -42,17 +42,17 @@ import javax.naming.directory.SearchControls;
* satisfy the filter. However, there might be limitations in the extent
* to which this can be supported by the service provider and underlying
* protocol/service. If the caller submits a filter that cannot be
- * supported in this way, addNamingListener() throws an
- * InvalidSearchFilterException.
+ * supported in this way, {@code addNamingListener()} throws an
+ * {@code InvalidSearchFilterException}.
*
- * See EventContext for a description of event source
+ * See {@code EventContext} for a description of event source
* and target, and information about listener registration/deregistration
* that are also applicable to methods in this interface.
* See the
* package description
* for information on threading issues.
*
- * A SearchControls or array object
+ * A {@code SearchControls} or array object
* passed as a parameter to any method is owned by the caller.
* The service provider will not modify the object or keep a reference to it.
*
@@ -64,15 +64,15 @@ import javax.naming.directory.SearchControls;
public interface EventDirContext extends EventContext, DirContext {
/**
* Adds a listener for receiving naming events fired
- * when objects identified by the search filter filter at
+ * when objects identified by the search filter {@code filter} at
* the object named by target are modified.
*
* The scope, returningObj flag, and returningAttributes flag from
- * the search controls ctls are used to control the selection
+ * the search controls {@code ctls} are used to control the selection
* of objects that the listener is interested in,
* and determines what information is returned in the eventual
- * NamingEvent object. Note that the requested
- * information to be returned might not be present in the NamingEvent
+ * {@code NamingEvent} object. Note that the requested
+ * information to be returned might not be present in the {@code NamingEvent}
* object if they are unavailable or could not be obtained by the
* service provider or service.
*
@@ -91,9 +91,9 @@ public interface EventDirContext extends EventContext, DirContext {
/**
* Adds a listener for receiving naming events fired when
- * objects identified by the search filter filter at the
+ * objects identified by the search filter {@code filter} at the
* object named by the string target name are modified.
- * See the overload that accepts a Name for details of
+ * See the overload that accepts a {@code Name} for details of
* how this method behaves.
*
* @param target The nonnull string name of the object resolved relative to this context.
@@ -111,14 +111,14 @@ public interface EventDirContext extends EventContext, DirContext {
/**
* Adds a listener for receiving naming events fired
- * when objects identified by the search filter filter and
+ * when objects identified by the search filter {@code filter} and
* filter arguments at the object named by the target are modified.
* The scope, returningObj flag, and returningAttributes flag from
- * the search controls ctls are used to control the selection
+ * the search controls {@code ctls} are used to control the selection
* of objects that the listener is interested in,
* and determines what information is returned in the eventual
- * NamingEvent object. Note that the requested
- * information to be returned might not be present in the NamingEvent
+ * {@code NamingEvent} object. Note that the requested
+ * information to be returned might not be present in the {@code NamingEvent}
* object if they are unavailable or could not be obtained by the
* service provider or service.
*
@@ -138,10 +138,10 @@ public interface EventDirContext extends EventContext, DirContext {
/**
* Adds a listener for receiving naming events fired when
- * objects identified by the search filter filter
+ * objects identified by the search filter {@code filter}
* and filter arguments at the
* object named by the string target name are modified.
- * See the overload that accepts a Name for details of
+ * See the overload that accepts a {@code Name} for details of
* how this method behaves.
*
* @param target The nonnull string name of the object resolved relative to this context.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/event/NamespaceChangeListener.java b/jdk/src/java.naming/share/classes/javax/naming/event/NamespaceChangeListener.java
index 281981daeb9..b20fc33e2f1 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/event/NamespaceChangeListener.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/event/NamespaceChangeListener.java
@@ -28,21 +28,21 @@ package javax.naming.event;
/**
* Specifies the methods that a listener interested in namespace changes
* must implement.
- * Specifically, the listener is interested in NamingEvents
- * with event types of OBJECT_ADDED, OBJECT_RENAMED, or
- * OBJECT_REMOVED.
+ * Specifically, the listener is interested in {@code NamingEvent}s
+ * with event types of {@code OBJECT_ADDED, OBJECT_RENAMED}, or
+ * {@code OBJECT_REMOVED}.
*
* Such a listener must:
*
* The binding of the newly added object can be obtained using
- * evt.getNewBinding().
+ * {@code evt.getNewBinding()}.
* @param evt The nonnull event.
* @see NamingEvent#OBJECT_ADDED
*/
@@ -70,7 +70,7 @@ public interface NamespaceChangeListener extends NamingListener {
* Called when an object has been removed.
*
* The binding of the newly removed object can be obtained using
- * evt.getOldBinding().
+ * {@code evt.getOldBinding()}.
* @param evt The nonnull event.
* @see NamingEvent#OBJECT_REMOVED
*/
@@ -80,8 +80,8 @@ public interface NamespaceChangeListener extends NamingListener {
* Called when an object has been renamed.
*
* The binding of the renamed object can be obtained using
- * evt.getNewBinding(). Its old binding (before the rename)
- * can be obtained using evt.getOldBinding().
+ * {@code evt.getNewBinding()}. Its old binding (before the rename)
+ * can be obtained using {@code evt.getOldBinding()}.
* One of these may be null if the old/new binding was outside the
* scope in which the listener has registered interest.
* @param evt The nonnull event.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/event/NamingEvent.java b/jdk/src/java.naming/share/classes/javax/naming/event/NamingEvent.java
index 4655e55ef91..b604ec0e2ba 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/event/NamingEvent.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/event/NamingEvent.java
@@ -30,9 +30,9 @@ import javax.naming.Binding;
/**
* This class represents an event fired by a naming/directory service.
*
- * The NamingEvent's state consists of
+ * The {@code NamingEvent}'s state consists of
*
- * Note that the event source is always the same EventContext
+ * Note that the event source is always the same {@code EventContext}
* instance that the listener has registered with.
* Furthermore, the names of the bindings in
- * the NamingEvent are always relative to that instance.
+ * the {@code NamingEvent} are always relative to that instance.
* For example, suppose a listener makes the following registration:
*
- * The old/new binding in NamingEvent may be null if the old
+ * The old/new binding in {@code NamingEvent} may be null if the old
* name or new name is outside of the scope for which the listener
* has registered.
*
@@ -102,7 +102,7 @@ public class NamingEvent extends java.util.EventObject {
* corresponding provider might not be able to prevent those
* notifications from being propagated to the listeners.
*
- * The value of this constant is 2.
+ * The value of this constant is {@code 2}.
*/
public static final int OBJECT_RENAMED = 2;
@@ -114,7 +114,7 @@ public class NamingEvent extends java.util.EventObject {
* be implemented by first removing the old binding and adding
* a new binding containing the same name but a different object.
*
- * The value of this constant is 3.
+ * The value of this constant is {@code 3}.
*/
public static final int OBJECT_CHANGED = 3;
@@ -147,16 +147,16 @@ public class NamingEvent extends java.util.EventObject {
protected Binding newBinding;
/**
- * Constructs an instance of NamingEvent.
+ * Constructs an instance of {@code NamingEvent}.
*
- * The names in newBd and oldBd are to be resolved relative
- * to the event source source.
+ * The names in {@code newBd} and {@code oldBd} are to be resolved relative
+ * to the event source {@code source}.
*
- * For an OBJECT_ADDED event type, newBd must not be null.
- * For an OBJECT_REMOVED event type, oldBd must not be null.
- * For an OBJECT_CHANGED event type, newBd and
- * oldBd must not be null. For an OBJECT_RENAMED event type,
- * one of newBd or oldBd may be null if the new or old
+ * For an {@code OBJECT_ADDED} event type, {@code newBd} must not be null.
+ * For an {@code OBJECT_REMOVED} event type, {@code oldBd} must not be null.
+ * For an {@code OBJECT_CHANGED} event type, {@code newBd} and
+ * {@code oldBd} must not be null. For an {@code OBJECT_RENAMED} event type,
+ * one of {@code newBd} or {@code oldBd} may be null if the new or old
* binding is outside of the scope for which the listener has registered.
*
* @param source The non-null context that fired this event.
@@ -192,13 +192,13 @@ public class NamingEvent extends java.util.EventObject {
/**
* Retrieves the event source that fired this event.
- * This returns the same object as EventObject.getSource().
+ * This returns the same object as {@code EventObject.getSource()}.
*
* If the result of this method is used to access the
* event source, for example, to look up the object or get its attributes,
- * then it needs to be locked because implementations of Context
+ * then it needs to be locked because implementations of {@code Context}
* are not guaranteed to be thread-safe
- * (and EventContext is a subinterface of Context).
+ * (and {@code EventContext} is a subinterface of {@code Context}).
* See the
* package description
* for more information on threading issues.
@@ -213,16 +213,16 @@ public class NamingEvent extends java.util.EventObject {
* Retrieves the binding of the object before the change.
*
* The binding must be nonnull if the object existed before the change
- * relative to the source context (getEventContext()).
- * That is, it must be nonnull for OBJECT_REMOVED and
- * OBJECT_CHANGED.
- * For OBJECT_RENAMED, it is null if the object before the rename
+ * relative to the source context ({@code getEventContext()}).
+ * That is, it must be nonnull for {@code OBJECT_REMOVED} and
+ * {@code OBJECT_CHANGED}.
+ * For {@code OBJECT_RENAMED}, it is null if the object before the rename
* is outside of the scope for which the listener has registered interest;
* it is nonnull if the object is inside the scope before the rename.
*
* The name in the binding is to be resolved relative
- * to the event source getEventContext().
- * The object returned by Binding.getObject() may be null if
+ * to the event source {@code getEventContext()}.
+ * The object returned by {@code Binding.getObject()} may be null if
* such information is unavailable.
*
* @return The possibly null binding of the object before the change.
@@ -235,16 +235,16 @@ public class NamingEvent extends java.util.EventObject {
* Retrieves the binding of the object after the change.
*
* The binding must be nonnull if the object existed after the change
- * relative to the source context (getEventContext()).
- * That is, it must be nonnull for OBJECT_ADDED and
- * OBJECT_CHANGED. For OBJECT_RENAMED,
+ * relative to the source context ({@code getEventContext()}).
+ * That is, it must be nonnull for {@code OBJECT_ADDED} and
+ * {@code OBJECT_CHANGED}. For {@code OBJECT_RENAMED},
* it is null if the object after the rename is outside the scope for
* which the listener registered interest; it is nonnull if the object
* is inside the scope after the rename.
*
* The name in the binding is to be resolved relative
- * to the event source getEventContext().
- * The object returned by Binding.getObject() may be null if
+ * to the event source {@code getEventContext()}.
+ * The object returned by {@code Binding.getObject()} may be null if
* such information is unavailable.
*
* @return The possibly null binding of the object after the change.
@@ -268,8 +268,8 @@ public class NamingEvent extends java.util.EventObject {
* Invokes the appropriate listener method on this event.
* The default implementation of
* this method handles the following event types:
- * OBJECT_ADDED, OBJECT_REMOVED,
- * OBJECT_RENAMED, OBJECT_CHANGED.
+ * {@code OBJECT_ADDED, OBJECT_REMOVED,
+ * OBJECT_RENAMED, OBJECT_CHANGED}.
*
* The listener method is executed in the same thread
* as this method. See the
diff --git a/jdk/src/java.naming/share/classes/javax/naming/event/NamingExceptionEvent.java b/jdk/src/java.naming/share/classes/javax/naming/event/NamingExceptionEvent.java
index 94aa11e394c..e8457a6e6f2 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/event/NamingExceptionEvent.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/event/NamingExceptionEvent.java
@@ -30,9 +30,9 @@ import javax.naming.NamingException;
/**
* This class represents an event fired when the procedures/processes
* used to collect information for notifying listeners of
- * NamingEvents threw a NamingException.
+ * {@code NamingEvent}s threw a {@code NamingException}.
* This can happen, for example, if the server which the listener is using
- * aborts subsequent to the addNamingListener() call.
+ * aborts subsequent to the {@code addNamingListener()} call.
*
* @author Rosanna Lee
* @author Scott Seligman
@@ -50,12 +50,12 @@ public class NamingExceptionEvent extends java.util.EventObject {
private NamingException exception;
/**
- * Constructs an instance of NamingExceptionEvent using
- * the context in which the NamingException was thrown and the exception
+ * Constructs an instance of {@code NamingExceptionEvent} using
+ * the context in which the {@code NamingException} was thrown and the exception
* that was thrown.
*
* @param source The non-null context in which the exception was thrown.
- * @param exc The non-null NamingException that was thrown.
+ * @param exc The non-null {@code NamingException} that was thrown.
*
*/
public NamingExceptionEvent(EventContext source, NamingException exc) {
@@ -72,16 +72,16 @@ public class NamingExceptionEvent extends java.util.EventObject {
}
/**
- * Retrieves the EventContext that fired this event.
- * This returns the same object as EventObject.getSource().
- * @return The non-null EventContext that fired this event.
+ * Retrieves the {@code EventContext} that fired this event.
+ * This returns the same object as {@code EventObject.getSource()}.
+ * @return The non-null {@code EventContext} that fired this event.
*/
public EventContext getEventContext() {
return (EventContext)getSource();
}
/**
- * Invokes the namingExceptionThrown() method on
+ * Invokes the {@code namingExceptionThrown()} method on
* a listener using this event.
* @param listener The non-null naming listener on which to invoke
* the method.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/event/NamingListener.java b/jdk/src/java.naming/share/classes/javax/naming/event/NamingListener.java
index 943d60f5ed7..b59432a0791 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/event/NamingListener.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/event/NamingListener.java
@@ -27,22 +27,22 @@ package javax.naming.event;
/**
* This interface is the root of listener interfaces that
- * handle NamingEvents.
+ * handle {@code NamingEvent}s.
* It does not make sense for a listener to implement just this interface.
- * A listener typically implements a subinterface of NamingListener,
- * such as ObjectChangeListener or NamespaceChangeListener.
+ * A listener typically implements a subinterface of {@code NamingListener},
+ * such as {@code ObjectChangeListener} or {@code NamespaceChangeListener}.
*
- * This interface contains a single method, namingExceptionThrown(),
+ * This interface contains a single method, {@code namingExceptionThrown()},
* that must be implemented so that the listener can be notified of
* exceptions that are thrown (by the service provider) while gathering
* information about the events that they're interested in.
* When this method is invoked, the listener has been automatically deregistered
- * from the EventContext with which it has registered.
+ * from the {@code EventContext} with which it has registered.
*
- * For example, suppose a listener implements ObjectChangeListener and
- * registers with a EventContext.
+ * For example, suppose a listener implements {@code ObjectChangeListener} and
+ * registers with a {@code EventContext}.
* Then, if the connection to the server is subsequently broken,
- * the listener will receive a NamingExceptionEvent and may
+ * the listener will receive a {@code NamingExceptionEvent} and may
* take some corrective action, such as notifying the user of the application.
*
* @author Rosanna Lee
@@ -57,7 +57,7 @@ package javax.naming.event;
public interface NamingListener extends java.util.EventListener {
/**
* Called when a naming exception is thrown while attempting
- * to fire a NamingEvent.
+ * to fire a {@code NamingEvent}.
*
* @param evt The nonnull event.
*/
diff --git a/jdk/src/java.naming/share/classes/javax/naming/event/ObjectChangeListener.java b/jdk/src/java.naming/share/classes/javax/naming/event/ObjectChangeListener.java
index 0d715fa9274..0f22f0d1242 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/event/ObjectChangeListener.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/event/ObjectChangeListener.java
@@ -26,27 +26,27 @@
package javax.naming.event;
/**
- * Specifies the method that a listener of a NamingEvent
- * with event type of OBJECT_CHANGED must implement.
+ * Specifies the method that a listener of a {@code NamingEvent}
+ * with event type of {@code OBJECT_CHANGED} must implement.
*
- * An OBJECT_CHANGED event type is fired when (the contents of)
+ * An {@code OBJECT_CHANGED} event type is fired when (the contents of)
* an object has changed. This might mean that its attributes have been modified,
* added, or removed, and/or that the object itself has been replaced.
* How the object has changed can be determined by examining the
- * NamingEvent's old and new bindings.
+ * {@code NamingEvent}'s old and new bindings.
*
- * A listener interested in OBJECT_CHANGED event types must:
+ * A listener interested in {@code OBJECT_CHANGED} event types must:
*
* The binding of the changed object can be obtained using
- * evt.getNewBinding(). Its old binding (before the change)
- * can be obtained using evt.getOldBinding().
+ * {@code evt.getNewBinding()}. Its old binding (before the change)
+ * can be obtained using {@code evt.getOldBinding()}.
* @param evt The nonnull naming event.
* @see NamingEvent#OBJECT_CHANGED
*/
diff --git a/jdk/src/java.naming/share/classes/javax/naming/event/package.html b/jdk/src/java.naming/share/classes/javax/naming/event/package.html
index e0db2305048..f63baf85dd8 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/event/package.html
+++ b/jdk/src/java.naming/share/classes/javax/naming/event/package.html
@@ -42,21 +42,21 @@ already deployed ones--can be accessed in a common way.
-This package defines a NamingEvent class to represent an event
+This package defines a
-NamingEvent represents an event that occurs in a
+
An application, for example, can register its interest in changes to
objects in a context as follows:
@@ -82,19 +82,19 @@ class ChangeHandler implements ObjectChangeListener {
-When a listener instance invokes NamingEvent.getEventContext(),
+When a listener instance invokes
- * Typically, ctl is a "basic" control containing
+ * Typically, {@code ctl} is a "basic" control containing
* BER encoded data. The factory is used to create a specialized
* control implementation, usually by decoding the BER encoded data,
* that provides methods to access that data in a type-safe and friendly
@@ -80,14 +80,14 @@ public abstract class ControlFactory {
* it is the only intended factory and that no other control factories
* should be tried. This might happen, for example, if the BER data
* in the control does not match what is expected of a control with
- * the given OID. Since this method throws NamingException,
+ * the given OID. Since this method throws {@code NamingException},
* any other internally generated exception that should be propagated
- * must be wrapped inside a NamingException.
+ * must be wrapped inside a {@code NamingException}.
*
* @param ctl A non-null control.
*
* @return A possibly null Control.
- * @exception NamingException If ctl contains invalid data that prevents it
+ * @exception NamingException If {@code ctl} contains invalid data that prevents it
* from being used to create a control. A factory should only throw
* an exception if it knows how to produce the control (identified by the OID)
* but is unable to because of, for example invalid BER data.
@@ -100,14 +100,14 @@ public abstract class ControlFactory {
* The following rule is used to create the control:
*
* For example, suppose the LDAP server supported a 'get time' extended operation.
@@ -90,7 +90,7 @@ public interface ExtendedRequest extends java.io.Serializable {
* Retrieves the object identifier of the request.
*
* @return The non-null object identifier string representing the LDAP
- * ExtendedRequest.requestName component.
+ * {@code ExtendedRequest.requestName} component.
*/
public String getID();
@@ -104,7 +104,7 @@ public interface ExtendedRequest extends java.io.Serializable {
* put into the extended operation to be sent to the LDAP server.
*
* @return A possibly null byte array representing the ASN.1 BER encoded
- * contents of the LDAP ExtendedRequest.requestValue
+ * contents of the LDAP {@code ExtendedRequest.requestValue}
* component.
* @exception IllegalStateException If the encoded value cannot be retrieved
* because the request contains insufficient or invalid data/state.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/ExtendedResponse.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/ExtendedResponse.java
index 576aa333246..36c83fd122c 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/ExtendedResponse.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/ExtendedResponse.java
@@ -78,7 +78,7 @@ public interface ExtendedResponse extends java.io.Serializable {
* If the server does not send it, the response will contain no ID (i.e. null).
*
* @return A possibly null object identifier string representing the LDAP
- * ExtendedResponse.responseName component.
+ * {@code ExtendedResponse.responseName} component.
*/
public String getID();
@@ -90,7 +90,7 @@ public interface ExtendedResponse extends java.io.Serializable {
* the response value. It does not include the response OID.
*
* @return A possibly null byte array representing the ASN.1 BER encoded
- * contents of the LDAP ExtendedResponse.response
+ * contents of the LDAP {@code ExtendedResponse.response}
* component.
*/
public byte[] getEncodedValue();
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/HasControls.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/HasControls.java
index fddc1bb3820..d90192ac262 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/HasControls.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/HasControls.java
@@ -60,10 +60,10 @@ import javax.naming.NamingException;
public interface HasControls {
/**
- * Retrieves an array of Controls from the object that
+ * Retrieves an array of {@code Control}s from the object that
* implements this interface. It is null if there are no controls.
*
- * @return A possibly null array of Control objects.
+ * @return A possibly null array of {@code Control} objects.
* @throws NamingException If cannot return controls due to an error.
*/
public Control[] getControls() throws NamingException;
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/InitialLdapContext.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/InitialLdapContext.java
index 1804829d34a..ad64f232b1f 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/InitialLdapContext.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/InitialLdapContext.java
@@ -34,24 +34,24 @@ import java.util.Hashtable;
* This class is the starting context for performing
* LDAPv3-style extended operations and controls.
*
- * See javax.naming.InitialContext and
- * javax.naming.InitialDirContext for details on synchronization,
+ * See {@code javax.naming.InitialContext} and
+ * {@code javax.naming.InitialDirContext} for details on synchronization,
* and the policy for how an initial context is created.
*
*
* The request controls supplied to the initial context constructor
* are not used as the context request controls
* for subsequent context operations such as searches and lookups.
* Context request controls are set and updated by using
- * setRequestControls().
+ * {@code setRequestControls()}.
*
* As shown, there can be two different sets of request controls
* associated with a context: connection request controls and context
@@ -67,14 +67,14 @@ import java.util.Hashtable;
* Controls[] respCtls = lctx.getResponseControls();
*
* Service provider implementors should read the "Service Provider" section
- * in the LdapContext class description for implementation details.
+ * in the {@code LdapContext} class description for implementation details.
*
* @author Rosanna Lee
* @author Scott Seligman
@@ -94,7 +94,7 @@ public class InitialLdapContext extends InitialDirContext implements LdapContext
/**
* Constructs an initial context using no environment properties or
* connection request controls.
- * Equivalent to new InitialLdapContext(null, null).
+ * Equivalent to {@code new InitialLdapContext(null, null)}.
*
* @throws NamingException if a naming exception is encountered
*/
@@ -105,15 +105,15 @@ public class InitialLdapContext extends InitialDirContext implements LdapContext
/**
* Constructs an initial context
* using environment properties and connection request controls.
- * See javax.naming.InitialContext for a discussion of
+ * See {@code javax.naming.InitialContext} for a discussion of
* environment properties.
*
* This constructor will not modify its parameters or
* save references to them, but may save a clone or copy.
* Caller should not modify mutable keys and values in
- * environment after it has been passed to the constructor.
+ * {@code environment} after it has been passed to the constructor.
*
- * connCtls is used as the underlying context instance's
+ * {@code connCtls} is used as the underlying context instance's
* connection request controls. See the class description
* for details.
*
@@ -159,7 +159,7 @@ public class InitialLdapContext extends InitialDirContext implements LdapContext
*
* @return The non-null cached initial context.
* @exception NotContextException If the initial context is not an
- * instance of LdapContext.
+ * instance of {@code LdapContext}.
* @exception NamingException If a naming exception was encountered.
*/
private LdapContext getDefaultLdapInitCtx() throws NamingException{
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/LdapContext.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/LdapContext.java
index d70b865790e..43cb3352d81 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/LdapContext.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/LdapContext.java
@@ -35,7 +35,7 @@ import java.util.Hashtable;
* extended operations.
*
* For applications that do not require such controls or extended
- * operations, the more generic javax.naming.directory.DirContext
+ * operations, the more generic {@code javax.naming.directory.DirContext}
* should be used instead.
*
*
* Unlike environment properties, request controls of a context instance
* are not inherited by context instances that are derived from
- * it. Derived context instances have null as their context
+ * it. Derived context instances have {@code null} as their context
* request controls. You must set the request controls of a derived context
- * instance explicitly using setRequestControls().
+ * instance explicitly using {@code setRequestControls()}.
*
* A context instance's request controls are retrieved using
- * the method getRequestControls().
+ * the method {@code getRequestControls()}.
*
*
* Like environment properties, connection request controls of a context
* are inherited by contexts that are derived from it.
* Typically, you initialize the connection request controls using the
- * InitialLdapContext constructor or
- * LdapReferralContext.getReferralContext(). These connection
+ * {@code InitialLdapContext} constructor or
+ * {@code LdapReferralContext.getReferralContext()}. These connection
* request controls are inherited by contexts that share the same
* connection--that is, contexts derived from the initial or referral
* contexts.
*
- * Use reconnect() to change the connection request controls of
+ * Use {@code reconnect()} to change the connection request controls of
* a context.
- * Invoking ldapContext.reconnect() affects only the
- * connection used by ldapContext and any new contexts instances that are
- * derived form ldapContext. Contexts that previously shared the
- * connection with ldapContext remain unchanged. That is, a context's
+ * Invoking {@code ldapContext.reconnect()} affects only the
+ * connection used by {@code ldapContext} and any new contexts instances that are
+ * derived form {@code ldapContext}. Contexts that previously shared the
+ * connection with {@code ldapContext} remain unchanged. That is, a context's
* connection request controls must be explicitly changed and is not
* affected by changes to another context's connection request
* controls.
*
* A context instance's connection request controls are retrieved using
- * the method getConnectControls().
+ * the method {@code getConnectControls()}.
*
*
- * This method sets this context's connCtls
+ * This method sets this context's {@code connCtls}
* to be its new connection request controls. This context's
* context request controls are not affected.
* After this method has been invoked, any subsequent
- * implicit reconnections will be done using connCtls.
- * connCtls are also used as
+ * implicit reconnections will be done using {@code connCtls}.
+ * {@code connCtls} are also used as
* connection request controls for new context instances derived from this
* context.
* These connection request controls are not
- * affected by setRequestControls().
+ * affected by {@code setRequestControls()}.
*
* Service provider implementors should read the "Service Provider" section
* in the class description for implementation details.
@@ -266,17 +266,17 @@ public interface LdapContext extends DirContext {
* caller.
*
* This removes any previous request controls and adds
- * requestControls
+ * {@code requestControls}
* for use by subsequent methods invoked on this context.
* This method does not affect this context's connection request controls.
*
- * Note that requestControls will be in effect until the next
- * invocation of setRequestControls(). You need to explicitly
- * invoke setRequestControls() with null or an empty
+ * Note that {@code requestControls} will be in effect until the next
+ * invocation of {@code setRequestControls()}. You need to explicitly
+ * invoke {@code setRequestControls()} with {@code null} or an empty
* array to clear the controls if you don't want them to affect the
* context methods any more.
* To check what request controls are in effect for this context, use
- * getRequestControls().
+ * {@code getRequestControls()}.
* @param requestControls The possibly null controls to use. If null, no
* controls are used.
* @exception NamingException If an error occurred while setting the
@@ -312,10 +312,10 @@ public interface LdapContext extends DirContext {
*
* When a context method that may return response controls is invoked,
* response controls from the previous method invocation are cleared.
- * getResponseControls() returns all of the response controls
+ * {@code getResponseControls()} returns all of the response controls
* generated by LDAP operations used by the context method in the order
* received from the LDAP server.
- * Invoking getResponseControls() does not
+ * Invoking {@code getResponseControls()} does not
* clear the response controls. You can call it many times (and get
* back the same controls) until the next context method that may return
* controls is invoked.
@@ -333,7 +333,7 @@ public interface LdapContext extends DirContext {
* of the property should be a colon-separated list of the fully
* qualified class names of factory classes that will create a control
* given another control. See
- * ControlFactory.getControlInstance() for details.
+ * {@code ControlFactory.getControlInstance()} for details.
* This property may be specified in the environment, a system property,
* or one or more resource files.
*
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/LdapName.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/LdapName.java
index 07dd18678a1..2ddb4242457 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/LdapName.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/LdapName.java
@@ -59,7 +59,7 @@ import java.io.IOException;
* characters (unescaped) are accepted.
*
*
- * String names passed to
- *
* Concurrent multithreaded read-only access of an instance of
- * LdapName need not be synchronized.
+ * {@code LdapName} need not be synchronized.
*
* Unless otherwise noted, the behavior of passing a null argument
* to a constructor or method in this class will cause a
@@ -129,7 +129,7 @@ public class LdapName implements Name {
* The indexing of RDNs in the list follows the numbering of
* RDNs described in the class description.
*
- * @param rdns The non-null list of Rdns forming this LDAP name.
+ * @param rdns The non-null list of {@code Rdn}s forming this LDAP name.
*/
public LdapName(List
- * A Control[] array passed as a parameter to
- * the getReferralContext() method is owned by the caller.
+ * A {@code Control[]} array passed as a parameter to
+ * the {@code getReferralContext()} method is owned by the caller.
* The service provider will not modify the array or keep a reference to it,
- * although it may keep references to the individual Control objects
+ * although it may keep references to the individual {@code Control} objects
* in the array.
*
* @author Rosanna Lee
@@ -73,20 +73,20 @@ public abstract class LdapReferralException extends ReferralException {
* Retrieves the context at which to continue the method using the
* context's environment and no controls.
* The referral context is created using the environment properties of
- * the context that threw the ReferralException and no controls.
+ * the context that threw the {@code ReferralException} and no controls.
*
* This method is equivalent to
*
* It is overridden in this class for documentation purposes only.
- * See ReferralException for how to use this method.
+ * See {@code ReferralException} for how to use this method.
*
* @return The non-null context at which to continue the method.
* @exception NamingException If a naming exception was encountered.
- * Call either retryReferral() or skipReferral()
+ * Call either {@code retryReferral()} or {@code skipReferral()}
* to continue processing referrals.
*/
public abstract Context getReferralContext() throws NamingException;
@@ -94,7 +94,7 @@ public abstract class LdapReferralException extends ReferralException {
/**
* Retrieves the context at which to continue the method using
* environment properties and no controls.
- * The referral context is created using env as its environment
+ * The referral context is created using {@code env} as its environment
* properties and no controls.
*
* This method is equivalent to
@@ -103,14 +103,14 @@ public abstract class LdapReferralException extends ReferralException {
*
*
* It is overridden in this class for documentation purposes only.
- * See ReferralException for how to use this method.
+ * See {@code ReferralException} for how to use this method.
*
* @param env The possibly null environment to use when retrieving the
* referral context. If null, no environment properties will be used.
*
* @return The non-null context at which to continue the method.
* @exception NamingException If a naming exception was encountered.
- * Call either retryReferral() or skipReferral()
+ * Call either {@code retryReferral()} or {@code skipReferral()}
* to continue processing referrals.
*/
public abstract Context
@@ -127,12 +127,12 @@ public abstract class LdapReferralException extends ReferralException {
* To continue the operation, the client program should re-invoke
* the method using the same arguments as the original invocation.
*
- * reqCtls is used when creating the connection to the referred
+ * {@code reqCtls} is used when creating the connection to the referred
* server. These controls will be used as the connection request controls for
* the context and context instances
* derived from the context.
- * reqCtls will also be the context's request controls for
- * subsequent context operations. See the LdapContext class
+ * {@code reqCtls} will also be the context's request controls for
+ * subsequent context operations. See the {@code LdapContext} class
* description for details.
*
* This method should be used instead of the other two overloaded forms
@@ -141,7 +141,7 @@ public abstract class LdapReferralException extends ReferralException {
* it needs to supply special controls relating to authentication.
*
* Service provider implementors should read the "Service Provider" section
- * in the LdapContext class description for implementation details.
+ * in the {@code LdapContext} class description for implementation details.
*
* @param reqCtls The possibly null request controls to use for the new context.
* If null or the empty array means use no request controls.
@@ -150,7 +150,7 @@ public abstract class LdapReferralException extends ReferralException {
* properties.
* @return The non-null context at which to continue the method.
* @exception NamingException If a naming exception was encountered.
- * Call either retryReferral() or skipReferral()
+ * Call either {@code retryReferral()} or {@code skipReferral()}
* to continue processing referrals.
*/
public abstract Context
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/Rdn.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/Rdn.java
index aa22285de23..6500d903623 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/Rdn.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/Rdn.java
@@ -50,7 +50,7 @@ import java.io.IOException;
* An example of an RDN is "OU=Sales+CN=J.Smith". In this example,
* the RDN consist of multiple attribute type/value pairs. The
* RDN is parsed as described in the class description for
- * {@link javax.naming.ldap.LdapName LdapName}.
+ * {@link javax.naming.ldap.LdapName LdapName}.
*
* The Rdn class represents an RDN as attribute type/value mappings,
* which can be viewed using
@@ -79,11 +79,11 @@ import java.io.IOException;
* Rdn rdn = new Rdn("cn", "Juicy, Fruit");
* System.out.println(rdn.toString());
*
- * The last line will print cn=Juicy\, Fruit. The
- * {@link #unescapeValue(String) unescapeValue()} method can be
+ * The last line will print {@code cn=Juicy\, Fruit}. The
+ * {@link #unescapeValue(String) unescapeValue()} method can be
* used to unescape the escaped comma resulting in the original
- * value "Juicy, Fruit". The {@link #escapeValue(Object)
- * escapeValue()} method adds the escape back preceding the comma.
+ * value {@code "Juicy, Fruit"}. The {@link #escapeValue(Object)
+ * escapeValue()} method adds the escape back preceding the comma.
*
* This class can be instantiated by a string representation
* of the RDN defined in RFC 2253 as shown in the following code example:
@@ -91,10 +91,10 @@ import java.io.IOException;
* Rdn rdn = new Rdn("cn=Juicy\\, Fruit");
* System.out.println(rdn.toString());
*
- * The last line will print cn=Juicy\, Fruit.
+ * The last line will print {@code cn=Juicy\, Fruit}.
*
* Concurrent multithreaded read-only access of an instance of
- * Rdn need not be synchronized.
+ * {@code Rdn} need not be synchronized.
*
* Unless otherwise noted, the behavior of passing a null argument
* to a constructor or method in this class will cause NullPointerException
@@ -123,7 +123,7 @@ public class Rdn implements Serializable, Comparable
- * Before making use of the cpe parameter, this method
+ * Before making use of the {@code cpe} parameter, this method
* updates the environment associated with that object by setting
- * the value of the property CPE
- * to cpe. This property will be inherited by the
+ * the value of the property {@code CPE}
+ * to {@code cpe}. This property will be inherited by the
* continuation context, and may be used by that context's
* service provider to inspect the fields of this exception.
*
@@ -826,15 +826,15 @@ public class NamingManager {
/**
* Retrieves the state of an object for binding.
*
- * Service providers that implement the DirContext interface
- * should use DirectoryManager.getStateToBind(), not this method.
- * Service providers that implement only the Context interface
+ * Service providers that implement the {@code DirContext} interface
+ * should use {@code DirectoryManager.getStateToBind()}, not this method.
+ * Service providers that implement only the {@code Context} interface
* should use this method.
*
* This method uses the specified state factories in
- * the Context.STATE_FACTORIES property from the environment
+ * the {@code Context.STATE_FACTORIES} property from the environment
* properties, and from the provider resource file associated with
- * nameCtx, in that order.
+ * {@code nameCtx}, in that order.
* The value of this property is a colon-separated list of factory
* class names that are tried in order, and the first one that succeeds
* in returning the object's state is the one used.
@@ -848,35 +848,35 @@ public class NamingManager {
* interface) must be public and must have a public constructor that
* accepts no arguments.
*
- * The
- * This method may return a Referenceable object. The
+ * This method may return a {@code Referenceable} object. The
* service provider obtaining this object may choose to store it
* directly, or to extract its reference (using
- * Referenceable.getReference()) and store that instead.
+ * {@code Referenceable.getReference()}) and store that instead.
*
* @param obj The non-null object for which to get state to bind.
- * @param name The name of this object relative to An ObjectFactory is responsible
+ * An {@code ObjectFactory} is responsible
* for creating objects of a specific type. In the above example,
* you may have a PrinterObjectFactory for creating Printer objects.
*
- * An object factory must implement the ObjectFactory interface.
+ * An object factory must implement the {@code ObjectFactory} interface.
* In addition, the factory class must be public and must have a
* public constructor that accepts no parameters.
*
- * The getObjectInstance() method of an object factory may
+ * The {@code getObjectInstance()} method of an object factory may
* be invoked multiple times, possibly using different parameters.
* The implementation is thread-safe.
*
@@ -73,15 +73,15 @@ public interface ObjectFactory {
* specified.
*
* Special requirements of this object are supplied
- * using
- * NamingManager.getObjectInstance()
+ * {@code NamingManager.getObjectInstance()}
* successively loads in object factories and invokes this method
* on them until one produces a non-null answer. When an exception
* is thrown by an object factory, the exception is passed on to the caller
- * of NamingManager.getObjectInstance()
+ * of {@code NamingManager.getObjectInstance()}
* (and no search is made for other factories
* that may produce a non-null answer).
* An object factory should only throw an exception if it is sure that
@@ -92,27 +92,27 @@ public interface ObjectFactory {
*
* A URL context factory is a special ObjectFactory that
* creates contexts for resolving URLs or objects whose locations
- * are specified by URLs. The getObjectInstance() method
+ * are specified by URLs. The {@code getObjectInstance()} method
* of a URL context factory will obey the following rules.
*
- * The name and environment parameters
+ * The {@code name} and {@code environment} parameters
* are owned by the caller.
* The implementation will not modify these objects or keep references
* to them, although it may keep references to clones or copies.
@@ -135,27 +135,27 @@ public interface ObjectFactory {
* Name and Context Parameters.
*
*
- * The
- * A Name parameter passed to any method is owned
+ * A {@code Name} parameter passed to any method is owned
* by the caller. The service provider will not modify the object
* or keep a reference to it.
- * A ResolveResult object returned by any
+ * A {@code ResolveResult} object returned by any
* method is owned by the caller. The caller may subsequently modify it;
* the service provider may not.
*
diff --git a/jdk/src/java.naming/share/classes/javax/naming/spi/StateFactory.java b/jdk/src/java.naming/share/classes/javax/naming/spi/StateFactory.java
index e4c5ca6087a..9ef15b88c89 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/spi/StateFactory.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/spi/StateFactory.java
@@ -34,14 +34,14 @@ import java.util.Hashtable;
* The JNDI framework allows for object implementations to
* be loaded in dynamically via object factories.
* For example, when looking up a printer bound in the name space,
- * if the print service binds printer names to References, the printer
- * Reference could be used to create a printer object, so that
+ * if the print service binds printer names to {@code Reference}s, the printer
+ * {@code Reference} could be used to create a printer object, so that
* the caller of lookup can directly operate on the printer object
* after the lookup.
- * An ObjectFactory is responsible
+ * An {@code ObjectFactory} is responsible
* for creating objects of a specific type. In the above example,
- * you may have a PrinterObjectFactory for creating
- * Printer objects.
+ * you may have a {@code PrinterObjectFactory} for creating
+ * {@code Printer} objects.
*
* For the reverse process, when an object is bound into the namespace,
* JNDI provides state factories.
@@ -50,23 +50,23 @@ import java.util.Hashtable;
*
- * A state factory must implement the StateFactory interface.
+ * A state factory must implement the {@code StateFactory} interface.
* In addition, the factory class must be public and must have a
* public constructor that accepts no parameters.
*
- * The getStateToBind() method of a state factory may
+ * The {@code getStateToBind()} method of a state factory may
* be invoked multiple times, possibly using different parameters.
* The implementation is thread-safe.
*
- * StateFactory is intended for use with service providers
- * that implement only the Context interface.
- * DirStateFactory is intended for use with service providers
- * that implement the DirContext interface.
+ * {@code StateFactory} is intended for use with service providers
+ * that implement only the {@code Context} interface.
+ * {@code DirStateFactory} is intended for use with service providers
+ * that implement the {@code DirContext} interface.
*
* @author Rosanna Lee
* @author Scott Seligman
@@ -81,18 +81,18 @@ public interface StateFactory {
/**
* Retrieves the state of an object for binding.
*
- * NamingManager.getStateToBind()
+ * {@code NamingManager.getStateToBind()}
* successively loads in state factories and invokes this method
* on them until one produces a non-null answer.
- * DirectoryManager.getStateToBind()
+ * {@code DirectoryManager.getStateToBind()}
* successively loads in state factories. If a factory implements
- * DirStateFactory, then DirectoryManager
- * invokes DirStateFactory.getStateToBind(); otherwise
- * it invokes StateFactory.getStateToBind().
+ * {@code DirStateFactory}, then {@code DirectoryManager}
+ * invokes {@code DirStateFactory.getStateToBind()}; otherwise
+ * it invokes {@code StateFactory.getStateToBind()}.
* When an exception
* is thrown by a factory, the exception is passed on to the caller
- * of NamingManager.getStateToBind() and
- * DirectoryManager.getStateToBind().
+ * of {@code NamingManager.getStateToBind()} and
+ * {@code DirectoryManager.getStateToBind()}.
* The search for other factories
* that may produce a non-null answer is halted.
* A factory should only throw an exception if it is sure that
@@ -110,7 +110,7 @@ public interface StateFactory {
* against concurrent access, since context implementations are not
* guaranteed to be thread-safe.
*
- * The name and environment parameters
+ * The {@code name} and {@code environment} parameters
* are owned by the caller.
* The implementation will not modify these objects or keep references
* to them, although it may keep references to clones or copies.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/spi/package.html b/jdk/src/java.naming/share/classes/javax/naming/spi/package.html
index f7480f0d98d..9e06fb71f73 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/spi/package.html
+++ b/jdk/src/java.naming/share/classes/javax/naming/spi/package.html
@@ -29,7 +29,7 @@ questions.
@@ -58,9 +58,9 @@ from the initial context.
name is made and stored.
- * Subsequent changes to name do not
+ * A copy of {@code name} is made and stored.
+ * Subsequent changes to {@code name} do not
* affect the copy in this NamingException and vice versa.
*
* @param name The possibly null name to set resolved name to.
@@ -218,14 +218,14 @@ public class NamingException extends Exception {
/**
* Sets the remaining name field of this exception.
*name is made and stored.
- * Subsequent changes to name do not
+ * A copy of {@code name} is made and stored.
+ * Subsequent changes to {@code name} 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.
@@ -275,11 +275,11 @@ public class NamingException extends Exception {
* Add components from 'name' as the last components in
* remaining name.
*name do not
+ * Subsequent changes to {@code name} 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.
@@ -326,7 +326,7 @@ public class NamingException extends Exception {
/**
* Records the root cause of this NamingException.
- * If e is this, this method does not do anything.
+ * If {@code e} is {@code this}, this method does not do anything.
*null if the cause is nonexistent or
+ * Returns {@code null} if the cause is nonexistent or
* unknown.
*
- * @return the cause of this exception, or null if the
+ * @return the cause of this exception, or {@code null} if the
* cause is nonexistent or unknown.
* @see #initCause(Throwable)
* @since 1.4
@@ -368,10 +368,10 @@ public class NamingException extends Exception {
* This method may be called at most once.
*
* @param cause the cause, which is saved for later retrieval by
- * the {@link #getCause()} method. A null value
+ * the {@link #getCause()} method. A {@code null} value
* indicates that the cause is nonexistent or unknown.
- * @return a reference to this NamingException instance.
- * @throws IllegalArgumentException if cause is this
+ * @return a reference to this {@code NamingException} instance.
+ * @throws IllegalArgumentException if {@code cause} is this
* exception. (A throwable cannot be its own cause.)
* @throws IllegalStateException if this method has already
* been called on this exception.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/Reference.java b/jdk/src/java.naming/share/classes/javax/naming/Reference.java
index 8b11bdc2e10..f1bc1c8c0cc 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/Reference.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/Reference.java
@@ -250,7 +250,7 @@ public class Reference implements Cloneable, java.io.Serializable {
* its effects on this enumeration are undefined.
*
* @return An non-null enumeration of the addresses
- * (RefAddr) in this reference.
+ * ({@code RefAddr}) in this reference.
* If this reference has zero addresses, an enumeration with
* zero elements is returned.
*/
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ReferralException.java b/jdk/src/java.naming/share/classes/javax/naming/ReferralException.java
index 7d3eaf3a849..c19a8a4d0f2 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ReferralException.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ReferralException.java
@@ -33,12 +33,12 @@ import java.util.Hashtable;
* such as that returned by LDAP v3 servers.
* {@code
+ * The following code sample shows how {@code ReferralException} can be used.
+ *
*
+ * }{@code
* while (true) {
* try {
* bindings = ctx.listBindings(name);
@@ -51,12 +51,12 @@ import java.util.Hashtable;
* ctx = e.getReferralContext();
* }
* }
- * }getReferralContext to allow the processing of
+ * {@code getReferralContext} to allow the processing of
* other referrals to continue.
* The following code fragment shows a typical usage pattern.
*
* It specifies first the critical controls for creating the initial context
- * (critConnCtls), and then sets the context's request controls
- * (critModCtls) for the context operation. If for some reason
- * lctx needs to reconnect to the server, it will use
- * critConnCtls. See the LdapContext interface for
+ * ({@code critConnCtls}), and then sets the context's request controls
+ * ({@code critModCtls}) for the context operation. If for some reason
+ * {@code lctx} needs to reconnect to the server, it will use
+ * {@code critConnCtls}. See the {@code LdapContext} interface for
* more discussion about request controls.
*
@@ -174,7 +174,7 @@ public abstract class ReferralException extends NamingException {
/**
* Retries the referral currently being processed.
* A call to this method should be followed by a call to
- * getReferralContext to allow the current
+ * {@code getReferralContext} to allow the current
* referral to be retried.
* The following code fragment shows a typical usage pattern.
*
* When an object named "x/y" is subsequently deleted, the corresponding
- * NamingEvent (evt) must contain:
+ * {@code NamingEvent} ({@code evt}) must contain:
*
diff --git a/jdk/src/java.naming/share/classes/javax/naming/directory/Attribute.java b/jdk/src/java.naming/share/classes/javax/naming/directory/Attribute.java
index 2cdc354d2da..d39f486c360 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/directory/Attribute.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/directory/Attribute.java
@@ -37,34 +37,34 @@ import javax.naming.OperationNotSupportedException;
* This interface represents an attribute associated with a named object.
*
Names
- * Each name passed as an argument to a DirContext method is relative
+ * Each name passed as an argument to a {@code DirContext} method is relative
* to that context. The empty name is used to name the context itself.
* The name parameter may never be null.
* Attribute Models
* There are two basic models of what attributes should be
@@ -82,7 +82,7 @@ import javax.naming.*;
* within the parent object and associated with the object's name.
*
* Attribute Type Names
- * In the getAttributes() and search() methods,
+ * In the {@code getAttributes()} and {@code search()} methods,
* you can supply the attributes to return by supplying a list of
* attribute names (strings).
* The attributes that you get back might not have the same names as the
@@ -120,9 +120,9 @@ import javax.naming.*;
* purposes. An example of operational attributes is the access control
* list for an object.
* Parameters
*InvalidAttributeValueException.
* InvalidAttributeValueException.
* search
* method that takes a filter argument.
* attributesToReturn
* and the name of the corresponding object, named relative
* to the context named by name.
@@ -709,7 +709,7 @@ public interface DirContext extends Context {
* the attributes to search for
* @param attributesToReturn
* the attributes to return
- * @return a non-null enumeration of SearchResult objects
+ * @return a non-null enumeration of {@code SearchResult} objects
* @throws NamingException if a naming exception is encountered
*/
public NamingEnumerationsearch(Name, Attributes, String[]).
*
* See {@link #search(Name, Attributes, String[])} for a full description.
@@ -732,7 +732,7 @@ public interface DirContext extends Context {
* the name of the context to search
* @param matchingAttributes
* the attributes to search for
- * @return an enumeration of SearchResult objects
+ * @return an enumeration of {@code SearchResult} objects
* @throws NamingException if a naming exception is encountered
*
* @see #search(Name, Attributes, String[])
@@ -750,7 +750,7 @@ public interface DirContext extends Context {
* the name of the context to search
* @param matchingAttributes
* the attributes to search for
- * @return an enumeration of SearchResult objects
+ * @return an enumeration of {@code SearchResult} objects
* @throws NamingException if a naming exception is encountered
*/
public NamingEnumerationInvalidSearchFilterException is thrown.
* name parameter), or
@@ -817,8 +817,8 @@ public interface DirContext extends Context {
* cons specifies a search scope of
* SearchControls.OBJECT_SCOPE or
* SearchControls.SUBSTREE_SCOPE), its name is the empty
- * string. The SearchResult may also contain attributes of the
- * matching object if the cons argument specified that attributes
+ * string. The {@code SearchResult} may also contain attributes of the
+ * matching object if the {@code cons} argument specified that attributes
* be returned.
*SearchControls.SUBSTREE_SCOPE),
* its name is the empty string.
*{i} expressions where i is outside
* the bounds of the array filterArgs
- * @throws InvalidSearchControlsException if cons contains
+ * @throws InvalidSearchControlsException if {@code cons} contains
* invalid settings
- * @throws InvalidSearchFilterException if filterExpr with
- * filterArgs represents an invalid search filter
+ * @throws InvalidSearchFilterException if {@code filterExpr} with
+ * {@code filterArgs} represents an invalid search filter
* @throws NamingException if a naming exception is encountered
*
* @see #search(Name, Attributes, String[])
@@ -1017,17 +1017,17 @@ public interface DirContext extends Context {
* @param cons
* the search controls that control the search. If null,
* the default search controls are used (equivalent
- * to (new SearchControls())).
- * @return an enumeration of SearchResults of the objects
+ * to {@code (new SearchControls())}).
+ * @return an enumeration of {@code SearchResult}s of the objects
* that satisfy the filter; never null
*
- * @throws ArrayIndexOutOfBoundsException if filterExpr contains
+ * @throws ArrayIndexOutOfBoundsException if {@code filterExpr} contains
* {i} expressions where i is outside
* the bounds of the array filterArgs
- * @throws InvalidSearchControlsException if cons contains
+ * @throws InvalidSearchControlsException if {@code cons} contains
* invalid settings
- * @throws InvalidSearchFilterException if filterExpr with
- * filterArgs represents an invalid search filter
+ * @throws InvalidSearchFilterException if {@code filterExpr} with
+ * {@code filterArgs} represents an invalid search filter
* @throws NamingException if a naming exception is encountered
*/
public NamingEnumerationsearch() method)
*
* @param className The possibly null class name of the object
- * bound to name. If null, the class name of obj is
- * returned by getClassName(). If obj is also null,
- * getClassName() will return null.
+ * bound to {@code name}. If null, the class name of {@code obj} is
+ * returned by {@code getClassName()}. If {@code obj} is also null,
+ * {@code getClassName()} will return null.
* @param obj The object bound to name. Can be null.
* @param attrs The attributes that were requested to be returned with
* this search item. Cannot be null.
@@ -127,9 +127,9 @@ public class SearchResult extends Binding {
*
* @param name The non-null name of the search item.
* @param className The possibly null class name of the object
- * bound to name. If null, the class name of obj is
- * returned by getClassName(). If obj is also null,
- * getClassName() will return null.
+ * bound to {@code name}. If null, the class name of {@code obj} is
+ * returned by {@code getClassName()}. If {@code obj} is also null,
+ * {@code getClassName()} will return null.
* @param obj The object bound to name. Can be null.
* @param attrs The attributes that were requested to be returned with
* this search item. Cannot be null.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/directory/package.html b/jdk/src/java.naming/share/classes/javax/naming/directory/package.html
index 82d066b5c13..c1f1860e5cf 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/directory/package.html
+++ b/jdk/src/java.naming/share/classes/javax/naming/directory/package.html
@@ -28,7 +28,7 @@ questions.
javax.naming package to provide functionality
for accessing directory services.
The Directory Context
-The DirContext
+The DirContext
interface represents a directory context.
It defines methods for examining and updating attributes associated with a
directory object, or directory entry as it is sometimes
called.
getAttributes() to retrieve the attributes
associated with a directory object (for which you supply the name).
-Attributes are modified using modifyAttributes().
+Attributes are modified using modifyAttributes().
You can add, replace, or remove attributes and/or attribute values
using this operation.
DirContext also behaves as a naming context
+by extending the Context interface in the javax.naming package.
This means that any directory object can also provide
a naming context.
For example, the directory object for a person might contain
@@ -69,13 +69,13 @@ a context for naming objects relative to that person
such as his printers and home directory.
Searches
-DirContext contains methods for
+DirContext contains methods for
performing content-based searching of the directory.
In the simplest and most common form of usage, the application
-specifies a set of attributes--possibly with specific
-values--to match, and submits this attribute set, to the
-search() method.
-There are other overloaded forms of search()
+specifies a set of attributes--possibly with specific
+values--to match, and submits this attribute set, to the
+search() method.
+There are other overloaded forms of search()
that support more sophisticated search filters.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/event/EventContext.java b/jdk/src/java.naming/share/classes/javax/naming/event/EventContext.java
index aacf161ebbe..7266dbb758e 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/event/EventContext.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/event/EventContext.java
@@ -35,7 +35,7 @@ import javax.naming.NamingException;
* events fired when objects named in a context changes.
*
*Target
- * The name parameter in the addNamingListener() methods is referred
+ * The name parameter in the {@code addNamingListener()} methods is referred
* to as the target. The target, along with the scope, identify
* the object(s) that the listener is interested in.
* It is possible to register interest in a target that does not exist, but
@@ -44,23 +44,23 @@ import javax.naming.NamingException;
*Event Source
- * The EventContext instance on which you invoke the
+ * The {@code EventContext} instance on which you invoke the
* registration methods is the event source of the events that are
* (potentially) generated.
* The source is not necessarily the object named by the target.
@@ -69,7 +69,7 @@ import javax.naming.NamingException;
* In other words, the target,
* along with the scope parameter, are used to identify
* the object(s) that the listener is interested in, but the event source
- * is the EventContext instance with which the listener
+ * is the {@code EventContext} instance with which the listener
* has registered.
*
*
* evt.getEventContext() == src
* evt.getOldBinding().getName().equals("x/y")
*Lifetime of Registration
* A registered listener becomes deregistered when:
*
- *
- * Until that point, a EventContext instance that has outstanding
+ * Until that point, a {@code EventContext} instance that has outstanding
* listeners will continue to exist and be maintained by the service provider.
*
*Listener Implementations
* The registration/deregistration methods accept an instance of
- * NamingListener. There are subinterfaces of NamingListener
- * for different of event types of NamingEvent.
- * For example, the ObjectChangeListener
- * interface is for the NamingEvent.OBJECT_CHANGED event type.
+ * {@code NamingListener}. There are subinterfaces of {@code NamingListener}
+ * for different of event types of {@code NamingEvent}.
+ * For example, the {@code ObjectChangeListener}
+ * interface is for the {@code NamingEvent.OBJECT_CHANGED} event type.
* To register interest in multiple event types, the listener implementation
- * should implement multiple NamingListener subinterfaces and use a
- * single invocation of addNamingListener().
+ * should implement multiple {@code NamingListener} subinterfaces and use a
+ * single invocation of {@code addNamingListener()}.
* In addition to reducing the number of method calls and possibly the code size
* of the listeners, this allows some service providers to optimize the
* registration.
*
*Threading Issues
*
- * Like Context instances in general, instances of
- * EventContext are not guaranteed to be thread-safe.
+ * Like {@code Context} instances in general, instances of
+ * {@code EventContext} are not guaranteed to be thread-safe.
* Care must be taken when multiple threads are accessing the same
- * EventContext concurrently.
+ * {@code EventContext} concurrently.
* See the
* package description
* for more information on threading issues.
@@ -138,7 +138,7 @@ public interface EventContext extends Context {
* Constant for expressing interest in events concerning the object named
* by the target.
*
*
- * A listener that wants to be notified of OBJECT_CHANGED event types
- * should also implement the ObjectChangeListener
+ * A listener that wants to be notified of {@code OBJECT_CHANGED} event types
+ * should also implement the {@code ObjectChangeListener}
* interface.
*
* @author Rosanna Lee
@@ -60,7 +60,7 @@ public interface NamespaceChangeListener extends NamingListener {
* Called when an object has been added.
*
- *
*
* When an object named "x/y" is subsequently deleted, the corresponding
- * NamingEvent (evt) must contain:
+ * {@code NamingEvent} ({@code evt}) must contain:
*
* NamespaceChangeListener listener = ...;
* src.addNamingListener("x", SUBTREE_SCOPE, listener);
*
*
* Care must be taken when multiple threads are accessing the same
- * EventContext concurrently.
+ * {@code EventContext} concurrently.
* See the
* package description
* for more information on threading issues.
@@ -73,13 +73,13 @@ import javax.naming.Binding;
public class NamingEvent extends java.util.EventObject {
/**
* Naming event type for indicating that a new object has been added.
- * The value of this constant is 0.
+ * The value of this constant is {@code 0}.
*/
public static final int OBJECT_ADDED = 0;
/**
* Naming event type for indicating that an object has been removed.
- * The value of this constant is 1.
+ * The value of this constant is {@code 1}.
*/
public static final int OBJECT_REMOVED = 1;
@@ -90,7 +90,7 @@ public class NamingEvent extends java.util.EventObject {
* be implemented by adding a binding with the new name and removing
* the old binding.
*
* evt.getEventContext() == src
* evt.getOldBinding().getName().equals("x/y")
*
*
- *
* A listener that wants to be notified of namespace change events
- * should also implement the NamespaceChangeListener
+ * should also implement the {@code NamespaceChangeListener}
* interface.
*
* @author Rosanna Lee
@@ -64,8 +64,8 @@ public interface ObjectChangeListener extends NamingListener {
* Called when an object has been changed.
*Naming Events
NamingEvent class to represent an event
that is generated by a naming/directory service.
-It also defines subinterfaces of Context and DirContext,
-called EventContext and EventDirContext,
+It also defines subinterfaces of Context and DirContext,
+called EventContext and EventDirContext,
through which applications can register their interest in events
fired by the context.
NamingEvent represents an event that occurs in a
naming or directory service. There are two categories of naming events:
Each category of events is handled by a corresponding listener:
-NamespaceChangeListener, ObjectChangeListener.
+NamespaceChangeListener, ObjectChangeListener.
Threading Issues
When an event is dispatched to a listener, the listener method (such
-as objectChanged()) may be executed in a thread other than the
-one in which the call to addNamingListener() was executed.
+as objectChanged()) may be executed in a thread other than the
+one in which the call to addNamingListener() was executed.
The choice of which thread to use is made by the service provider.
When an event is dispatched to multiple listeners, the service provider
may choose (and is generally encouraged) to execute the listener methods
concurrently in separate threads.
NamingEvent.getEventContext(),
it must take into account the possibility that other threads will be
working with that context concurrently. Likewise, when a listener is
-registered via addNamingListener(), the registering thread
+registered via addNamingListener(), the registering thread
must take into account the likely possibility that the service provider
-will later invoke the listeners in newly-created threads. As Context
+will later invoke the listeners in newly-created threads. As Context
instances are not guaranteed to be thread-safe in general, all context
operations must be synchronized as needed.
@@ -107,9 +107,9 @@ to make a request to the server to register interest in changes
on the server that will eventually be translated into events.
If an exception occurs that prevents information about the events from
being collected, the listener will never be notified of the events.
-When such an exception occurs, a NamingExceptionEvent is
+When such an exception occurs, a NamingExceptionEvent is
fired to notify the listener. The listener's
-namingExceptionThrown() method is invoked, as shown in the
+namingExceptionThrown() method is invoked, as shown in the
sample code above,
and the listener is automatically deregistered.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/BasicControl.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/BasicControl.java
index 5ce57a57203..0060d281563 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/BasicControl.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/BasicControl.java
@@ -26,7 +26,7 @@
package javax.naming.ldap;
/**
- * This class provides a basic implementation of the Control
+ * This class provides a basic implementation of the {@code Control}
* interface. It represents an LDAPv3 Control as defined in
* RFC 2251.
*
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/Control.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/Control.java
index b496716740f..93d21019f65 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/Control.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/Control.java
@@ -52,13 +52,13 @@ package javax.naming.ldap;
public interface Control extends java.io.Serializable {
/**
* Indicates a critical control.
- * The value of this constant is true.
+ * The value of this constant is {@code true}.
*/
public static final boolean CRITICAL = true;
/**
* Indicates a non-critical control.
- * The value of this constant is false.
+ * The value of this constant is {@code false}.
*/
public static final boolean NONCRITICAL = false;
@@ -75,7 +75,7 @@ public interface Control extends java.io.Serializable {
* In other words, if the server receives a critical control
* that it does not support, regardless of whether the control
* makes sense for the operation, the operation will not be performed
- * and an OperationNotSupportedException will be thrown.
+ * and an {@code OperationNotSupportedException} will be thrown.
* @return true if this control is critical; false otherwise.
*/
public boolean isCritical();
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/ControlFactory.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/ControlFactory.java
index 8d754d02b85..afb28ad347f 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/ControlFactory.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/ControlFactory.java
@@ -65,7 +65,7 @@ public abstract class ControlFactory {
* Without this mechanism, the provider would be returning
* controls that only contained data in BER encoded format.
*
*
@@ -119,9 +119,9 @@ public abstract class ControlFactory {
* @param ctx The possibly null context in which the control is being created.
* If null, no such information is available.
* @param env The possibly null environment of the context. This is used
- * to find the value of the LdapContext.CONTROL_FACTORIES property.
- * @return A control object created using ctl.
+ * return {@code ctl}.
* If an exception is encountered while creating the control, the
* exception is passed up to the caller.
*ctl; or
- * ctl if a control object cannot be created using
+ * to find the value of the {@code LdapContext.CONTROL_FACTORIES} property.
+ * @return A control object created using {@code ctl}; or
+ * {@code ctl} if a control object cannot be created using
* the algorithm described above.
* @exception NamingException if a naming exception was encountered
* while attempting to create the control object.
@@ -129,7 +129,7 @@ public abstract class ControlFactory {
* exception, it is propagated up to the caller.
* If an error was encountered while loading
* and instantiating the factory and object classes, the exception
- * is wrapped inside a NamingException and then rethrown.
+ * is wrapped inside a {@code NamingException} and then rethrown.
*/
public static Control getControlInstance(Control ctl, Context ctx,
Hashtable env)
diff --git a/jdk/src/java.naming/share/classes/javax/naming/ldap/ExtendedRequest.java b/jdk/src/java.naming/share/classes/javax/naming/ldap/ExtendedRequest.java
index a528df5e28a..b37b65f1275 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/ldap/ExtendedRequest.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/ldap/ExtendedRequest.java
@@ -43,7 +43,7 @@ import javax.naming.NamingException;
* the classes that implement this interface, supplying them with
* any information required for a particular extended operation request.
* It would then pass such a class as an argument to the
- * LdapContext.extendedOperation() method for performing the
+ * {@code LdapContext.extendedOperation()} method for performing the
* LDAPv3 extended operation.
*Request Controls
- * When you create an initial context (InitialLdapContext),
+ * When you create an initial context ({@code InitialLdapContext}),
* you can specify a list of request controls.
* These controls will be used as the request controls for any
* implicit LDAP "bind" operation performed by the context or contexts
* derived from the context. These are called connection request controls.
- * Use getConnectControls() to get a context's connection request
+ * Use {@code getConnectControls()} to get a context's connection request
* controls.
*Usage Details About Controls
@@ -44,7 +44,7 @@ import java.util.Hashtable;
* At a high level, this support allows a user
* program to set request controls for LDAP operations that are executed
* in the course of the user program's invocation of
- * Context/DirContext
+ * {@code Context}/{@code DirContext}
* methods, and read response controls resulting from LDAP operations.
* At the implementation level, there are some details that developers of
* both the user program and service providers need to understand in order
@@ -78,60 +78,60 @@ import java.util.Hashtable;
* Context Request Controls
* There are two ways in which a context instance gets its request controls:
*
- *
- * where ldapContext is an instance of LdapContext.
- * Specifying null or an empty array for reqCtls
+ * where {@code ldapContext} is an instance of {@code LdapContext}.
+ * Specifying {@code null} or an empty array for {@code reqCtls}
* means no request controls.
- * newInstance() creates a new instance of a context using
- * reqCtls, while setRequestControls()
- * updates an existing context instance's request controls to reqCtls.
+ * {@code newInstance()} creates a new instance of a context using
+ * {@code reqCtls}, while {@code setRequestControls()}
+ * updates an existing context instance's request controls to {@code reqCtls}.
* ldapContext.newInstance(reqCtls)
+ * ldapContext.setRequestControls(reqCtls)
* Connection Request Controls
* There are three ways in which connection request controls are set:
*
- *
- * where refException is an instance of
- * LdapReferralException, and ldapContext is an
- * instance of LdapContext.
- * Specifying null or an empty array for connCtls
+ * where {@code refException} is an instance of
+ * {@code LdapReferralException}, and {@code ldapContext} is an
+ * instance of {@code LdapContext}.
+ * Specifying {@code null} or an empty array for {@code connCtls}
* means no connection request controls.
*
+ * new InitialLdapContext(env, connCtls)
+ * refException.getReferralContext(env, connCtls)
+ * ldapContext.reconnect(connCtls);
* Service Provider Requirements
*
@@ -145,22 +145,22 @@ import java.util.Hashtable;
*
* Response Controls
*
- * The method LdapContext.getResponseControls() is used to
+ * The method {@code LdapContext.getResponseControls()} is used to
* retrieve the response controls generated by LDAP operations executed
- * as the result of invoking a Context/DirContext
+ * as the result of invoking a {@code Context}/{@code DirContext}
* operation. The result is all of the responses controls generated
* by the underlying LDAP operations, including any implicit reconnection.
* To get only the reconnection response controls,
- * use reconnect() followed by getResponseControls().
+ * use {@code reconnect()} followed by {@code getResponseControls()}.
*
* Parameters
*
- * A Control[] array
+ * A {@code Control[]} array
* passed as a parameter to any method is owned by the caller.
* The service provider will not modify the array or keep a reference to it,
- * although it may keep references to the individual Control objects
+ * although it may keep references to the individual {@code Control} objects
* in the array.
- * A Control[] array returned by any method is immutable, and may
+ * A {@code Control[]} array returned by any method is immutable, and may
* not subsequently be modified by either the caller or the service provider.
*
* @author Rosanna Lee
@@ -207,7 +207,7 @@ public interface LdapContext extends DirContext {
* to use for the new context.
* If null, the context is initialized with no request controls.
*
- * @return A non-null LdapContext instance.
+ * @return A non-null {@code LdapContext} instance.
* @exception NamingException If an error occurred while creating
* the new instance.
* @see InitialLdapContext
@@ -224,16 +224,16 @@ public interface LdapContext extends DirContext {
* the LDAP "bind" operation, or to explicitly connect to the server
* to get response controls returned by the LDAP "bind" operation.
*LdapName or returned by it
+ * String names passed to {@code LdapName} or returned by it
* use the full Unicode character set. They may also contain
* characters encoded into UTF-8 with each octet represented by a
* three-character substring such as "\\B4".
@@ -67,7 +67,7 @@ import java.io.IOException;
* each octet represented by a single character in the string: the
* meaning would be ambiguous.
*LdapName will properly parse all valid names, but
+ * {@code LdapName} will properly parse all valid names, but
* does not attempt to detect all possible violations when parsing
* invalid names. It is "generous" in accepting invalid names.
* The "validity" of a name is determined ultimately when it
@@ -92,7 +92,7 @@ import java.io.IOException;
* empty LDAP name is represented by an empty RDN list.
*
- * where ctx is the context that threw the ReferralException.
+ * where {@code ctx} is the context that threw the {@code ReferralException.}
*
* getReferralContext(ctx.getEnvironment(), null);
*
*
CannotProceedException containing information
+ * {@code CannotProceedException} containing information
* pinpointing how far it has proceeded. It then obtains a
* continuation context from JNDI by calling
- * getContinuationContext. The context
+ * {@code getContinuationContext}. The context
* implementation should then resume the context operation by
* invoking the same operation on the continuation context, using
* the remainder of the name that has not yet been resolved.
*name and nameCtx parameters may
+ * The {@code name} and {@code nameCtx} parameters may
* optionally be used to specify the name of the object being created.
* See the description of "Name and Context Parameters" in
* {@link ObjectFactory#getObjectInstance
* ObjectFactory.getObjectInstance()}
* for details.
* nameCtx,
+ * @param name The name of this object relative to {@code nameCtx},
* or null if no name is specified.
- * @param nameCtx The context relative to which the name
- * parameter is specified, or null if name is
+ * @param nameCtx The context relative to which the {@code name}
+ * parameter is specified, or null if {@code name} is
* relative to the default initial context.
* @param environment The possibly null environment to
* be used in the creation of the state factory and
* the object's state.
- * @return The non-null object representing obj's state for
- * binding. It could be the object (obj) itself.
+ * @return The non-null object representing {@code obj}'s state for
+ * binding. It could be the object ({@code obj}) itself.
* @exception NamingException If one of the factories accessed throws an
* exception, or if an error was encountered while loading
* and instantiating the factory and object classes.
* A factory should only throw an exception if it does not want
* other factories to be used in an attempt to create an object.
- * See StateFactory.getStateToBind().
+ * See {@code StateFactory.getStateToBind()}.
* @see StateFactory
* @see StateFactory#getStateToBind
* @see DirectoryManager#getStateToBind
diff --git a/jdk/src/java.naming/share/classes/javax/naming/spi/ObjectFactory.java b/jdk/src/java.naming/share/classes/javax/naming/spi/ObjectFactory.java
index a02528cec9f..905902234fb 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/spi/ObjectFactory.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/spi/ObjectFactory.java
@@ -39,15 +39,15 @@ import javax.naming.*;
* Reference could be used to create a printer object, so that
* the caller of lookup can directly operate on the printer object
* after the lookup.
- * environment.
+ * using {@code environment}.
* An example of such an environment property is user identity
* information.
*
- *
*
* obj is null, create a context for resolving URLs of the
+ * obj set to null on an LDAP URL context factory would return a
+ * scheme id. For example, invoking {@code getObjectInstance()} with
+ * {@code obj} set to null on an LDAP URL context factory would return a
* context that can resolve LDAP URLs
* such as "ldap://ldap.wiz.com/o=wiz,c=us" and
* "ldap://ldap.umich.edu/o=umich,c=us".
* obj is a URL string, create an object (typically a context)
+ * If {@code obj} is a URL string, create an object (typically a context)
* identified by the URL. For example, suppose this is an LDAP URL context
- * factory. If obj is "ldap://ldap.wiz.com/o=wiz,c=us",
+ * factory. If {@code obj} is "ldap://ldap.wiz.com/o=wiz,c=us",
* getObjectInstance() would return the context named by the distinguished
* name "o=wiz, c=us" at the LDAP server ldap.wiz.com. This context can
* then be used to resolve LDAP names (such as "cn=George")
* relative to that context.
* obj is an array of URL strings, the assumption is that the
+ * If {@code obj} is an array of URL strings, the assumption is that the
* URLs are equivalent in terms of the context to which they refer.
* Verification of whether the URLs are, or need to be, equivalent is up
* to the context factory. The order of the URLs in the array is
@@ -120,13 +120,13 @@ public interface ObjectFactory {
* The object returned by getObjectInstance() is like that of the single
* URL case. It is the object named by the URLs.
* obj is of any other type, the behavior of
- * getObjectInstance() is determined by the context factory
+ * If {@code obj} is of any other type, the behavior of
+ * {@code getObjectInstance()} is determined by the context factory
* implementation.
* name and nameCtx parameters may
+ * The {@code name} and {@code nameCtx} parameters may
* optionally be used to specify the name of the object being created.
- * name is the name of the object, relative to context
- * nameCtx.
+ * {@code name} is the name of the object, relative to context
+ * {@code nameCtx}.
* If there are several possible contexts from which the object
* could be named -- as will often be the case -- it is up to
* the caller to select one. A good rule of thumb is to select the
* "deepest" context available.
- * If nameCtx is null, name is relative
+ * If {@code nameCtx} is null, {@code name} is relative
* to the default initial context. If no name is being specified, the
- * name parameter should be null.
- * If a factory uses nameCtx it should synchronize its use
+ * {@code name} parameter should be null.
+ * If a factory uses {@code nameCtx} it should synchronize its use
* against concurrent access, since context implementations are not
* guaranteed to be thread-safe.
*
* @param obj The possibly null object containing location or reference
* information that can be used in creating an object.
- * @param name The name of this object relative to nameCtx,
+ * @param name The name of this object relative to {@code nameCtx},
* or null if no name is specified.
- * @param nameCtx The context relative to which the name
- * parameter is specified, or null if name is
+ * @param nameCtx The context relative to which the {@code name}
+ * parameter is specified, or null if {@code name} is
* relative to the default initial context.
* @param environment The possibly null environment that is used in
* creating the object.
diff --git a/jdk/src/java.naming/share/classes/javax/naming/spi/ObjectFactoryBuilder.java b/jdk/src/java.naming/share/classes/javax/naming/spi/ObjectFactoryBuilder.java
index 19c07f0c060..8e8c6161c01 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/spi/ObjectFactoryBuilder.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/spi/ObjectFactoryBuilder.java
@@ -40,10 +40,10 @@ import javax.naming.NamingException;
* after the lookup. An ObjectFactory is responsible for creating
* objects of a specific type. JNDI uses a default policy for using
* and loading object factories. You can override this default policy
- * by calling NamingManager.setObjectFactoryBuilder() with an ObjectFactoryBuilder,
+ * by calling {@code NamingManager.setObjectFactoryBuilder()} with an ObjectFactoryBuilder,
* which contains the program-defined way of creating/loading
* object factories.
- * Any ObjectFactoryBuilder implementation must implement this
+ * Any {@code ObjectFactoryBuilder} implementation must implement this
* interface that for creating object factories.
*
* @author Rosanna Lee
diff --git a/jdk/src/java.naming/share/classes/javax/naming/spi/Resolver.java b/jdk/src/java.naming/share/classes/javax/naming/spi/Resolver.java
index 765490fc391..26d2d18172e 100644
--- a/jdk/src/java.naming/share/classes/javax/naming/spi/Resolver.java
+++ b/jdk/src/java.naming/share/classes/javax/naming/spi/Resolver.java
@@ -37,10 +37,10 @@ import javax.naming.NamingException;
* that do not support subtypes of Context, but which can act as
* intermediate contexts for resolution purposes.
*
- * The service provider for ctx uses a state factory
- * to obtain the state of printer for binding into its namespace.
- * A state factory for the Printer type object might return
+ * The service provider for {@code ctx} uses a state factory
+ * to obtain the state of {@code printer} for binding into its namespace.
+ * A state factory for the {@code Printer} type object might return
* a more compact object for storage in the naming system.
*
* ctx.rebind("inky", printer);
* javax.naming
and related packages.
Java Object Support
-The service provider package provides support
+The service provider package provides support
for implementors of the
-javax.naming.Context.lookup()
+javax.naming.Context.lookup()
method and related methods to return Java objects that are natural
and intuitive for the Java programmer.
For example, when looking up a printer name from the directory,