提交 944d6d25 编写于 作者: D darcy

8026840: Fix new doclint issues in javax.naming

Reviewed-by: mchung
上级 43e7cb30
...@@ -41,7 +41,7 @@ import java.util.Properties; ...@@ -41,7 +41,7 @@ import java.util.Properties;
* This range may be written as [0,N). * This range may be written as [0,N).
* The most significant component is at index 0. * The most significant component is at index 0.
* An empty composite name has no components. * An empty composite name has no components.
*<p> *
* <h1>JNDI Composite Name Syntax</h1> * <h1>JNDI Composite Name Syntax</h1>
* JNDI defines a standard string representation for composite names. This * JNDI defines a standard string representation for composite names. This
* representation is the concatenation of the components of a composite name * representation is the concatenation of the components of a composite name
...@@ -72,12 +72,12 @@ import java.util.Properties; ...@@ -72,12 +72,12 @@ import java.util.Properties;
* A trailing component separator (the composite name string ends with * A trailing component separator (the composite name string ends with
* a separator) denotes a trailing empty component. * a separator) denotes a trailing empty component.
* Adjacent component separators denote an empty component. * Adjacent component separators denote an empty component.
*<p> *
*<h1>Composite Name Examples</h1> *<h1>Composite Name Examples</h1>
*This table shows examples of some composite names. Each row shows *This table shows examples of some composite names. Each row shows
*the string form of a composite name and its corresponding structural form *the string form of a composite name and its corresponding structural form
*(<tt>CompositeName</tt>). *(<tt>CompositeName</tt>).
*<p> *
<table border="1" cellpadding=3 summary="examples showing string form of composite name and its corresponding structural form (CompositeName)"> <table border="1" cellpadding=3 summary="examples showing string form of composite name and its corresponding structural form (CompositeName)">
<tr> <tr>
...@@ -136,7 +136,7 @@ import java.util.Properties; ...@@ -136,7 +136,7 @@ import java.util.Properties;
<td>{"x", "", "y"}</td> <td>{"x", "", "y"}</td>
</tr> </tr>
</table> </table>
* <p> *
*<h1>Composition Examples</h1> *<h1>Composition Examples</h1>
* Here are some composition examples. The right column shows composing * Here are some composition examples. The right column shows composing
* string composite names while the left column shows composing the * string composite names while the left column shows composing the
...@@ -144,7 +144,7 @@ import java.util.Properties; ...@@ -144,7 +144,7 @@ import java.util.Properties;
* string forms of two composite names simply involves concatenating * string forms of two composite names simply involves concatenating
* their string forms together. * their string forms together.
<p> <table border="1" cellpadding=3 summary="composition examples showing string names and composite names"> <table border="1" cellpadding=3 summary="composition examples showing string names and composite names">
<tr> <tr>
<th>String Names</th> <th>String Names</th>
...@@ -188,7 +188,7 @@ import java.util.Properties; ...@@ -188,7 +188,7 @@ import java.util.Properties;
</tr> </tr>
</table> </table>
*<p> *
*<h1>Multithreaded Access</h1> *<h1>Multithreaded Access</h1>
* A <tt>CompositeName</tt> instance is not synchronized against concurrent * A <tt>CompositeName</tt> instance is not synchronized against concurrent
* multithreaded access. Multiple threads trying to access and modify a * multithreaded access. Multiple threads trying to access and modify a
......
...@@ -38,7 +38,7 @@ import java.util.Properties; ...@@ -38,7 +38,7 @@ import java.util.Properties;
* This range may be written as [0,N). * This range may be written as [0,N).
* The most significant component is at index 0. * The most significant component is at index 0.
* An empty compound name has no components. * An empty compound name has no components.
*<p> *
* <h1>Compound Name Syntax</h1> * <h1>Compound Name Syntax</h1>
* The syntax of a compound name is specified using a set of properties: * The syntax of a compound name is specified using a set of properties:
*<dl> *<dl>
...@@ -135,7 +135,7 @@ import java.util.Properties; ...@@ -135,7 +135,7 @@ import java.util.Properties;
* applied (e.g. embedded separators are escaped or quoted) * applied (e.g. embedded separators are escaped or quoted)
* so that when the same string is parsed, it will yield the same components * so that when the same string is parsed, it will yield the same components
* of the original compound name. * of the original compound name.
*<p> *
*<h1>Multithreaded Access</h1> *<h1>Multithreaded Access</h1>
* A <tt>CompoundName</tt> instance is not synchronized against concurrent * A <tt>CompoundName</tt> instance is not synchronized against concurrent
* multithreaded access. Multiple threads trying to access and modify a * multithreaded access. Multiple threads trying to access and modify a
......
...@@ -31,7 +31,7 @@ import java.util.Hashtable; ...@@ -31,7 +31,7 @@ import java.util.Hashtable;
* This interface represents a naming context, which * This interface represents a naming context, which
* consists of a set of name-to-object bindings. * consists of a set of name-to-object bindings.
* It contains methods for examining and updating these bindings. * It contains methods for examining and updating these bindings.
* <p> *
* <h1>Names</h1> * <h1>Names</h1>
* Each name passed as an argument to a <tt>Context</tt> method is relative * Each name passed as an argument to a <tt>Context</tt> method is relative
* to that context. The empty name is used to name the context itself. * to that context. The empty name is used to name the context itself.
...@@ -68,12 +68,12 @@ import java.util.Hashtable; ...@@ -68,12 +68,12 @@ import java.util.Hashtable;
* <tt>NamingEnumeration</tt> may be names in their own namespace rather than * <tt>NamingEnumeration</tt> may be names in their own namespace rather than
* names in a composite namespace, at the discretion of the service * names in a composite namespace, at the discretion of the service
* provider. * provider.
*<p> *
*<h1>Exceptions</h1> *<h1>Exceptions</h1>
* All the methods in this interface can throw a <tt>NamingException</tt> or * All the methods in this interface can throw a <tt>NamingException</tt> or
* any of its subclasses. See <tt>NamingException</tt> and their subclasses * any of its subclasses. See <tt>NamingException</tt> and their subclasses
* for details on each exception. * for details on each exception.
*<p> *
*<h1>Concurrent Access</h1> *<h1>Concurrent Access</h1>
* A Context instance is not guaranteed to be synchronized against * A Context instance is not guaranteed to be synchronized against
* concurrent access by multiple threads. Threads that need to access * concurrent access by multiple threads. Threads that need to access
...@@ -90,7 +90,7 @@ import java.util.Hashtable; ...@@ -90,7 +90,7 @@ import java.util.Hashtable;
* use, or while any referrals generated by that operation are still * use, or while any referrals generated by that operation are still
* being followed. * being followed.
* *
*<p> *
*<h1>Parameters</h1> *<h1>Parameters</h1>
* A <tt>Name</tt> parameter passed to any method of the * A <tt>Name</tt> parameter passed to any method of the
* <tt>Context</tt> interface or one of its subinterfaces * <tt>Context</tt> interface or one of its subinterfaces
...@@ -102,7 +102,7 @@ import java.util.Hashtable; ...@@ -102,7 +102,7 @@ import java.util.Hashtable;
* A <tt>Name</tt> returned by any such method is owned by the caller. * A <tt>Name</tt> returned by any such method is owned by the caller.
* The caller may subsequently modify it; the service provider may not. * The caller may subsequently modify it; the service provider may not.
* *
*<p> *
*<h1>Environment Properties</h1> *<h1>Environment Properties</h1>
*<p> *<p>
* JNDI applications need a way to communicate various preferences * JNDI applications need a way to communicate various preferences
......
...@@ -361,7 +361,7 @@ public class InitialContext implements Context { ...@@ -361,7 +361,7 @@ public class InitialContext implements Context {
* follows. * follows.
* Define a new method that uses this method to get an initial * Define a new method that uses this method to get an initial
* context of the desired subclass. * context of the desired subclass.
* <p><blockquote><pre> * <blockquote><pre>
* protected XXXContext getURLOrDefaultInitXXXCtx(Name name) * protected XXXContext getURLOrDefaultInitXXXCtx(Name name)
* throws NamingException { * throws NamingException {
* Context answer = getURLOrDefaultInitCtx(name); * Context answer = getURLOrDefaultInitCtx(name);
...@@ -377,7 +377,7 @@ public class InitialContext implements Context { ...@@ -377,7 +377,7 @@ public class InitialContext implements Context {
* </pre></blockquote> * </pre></blockquote>
* When providing implementations for the new methods in the subclass, * When providing implementations for the new methods in the subclass,
* use this newly defined method to get the initial context. * use this newly defined method to get the initial context.
* <p><blockquote><pre> * <blockquote><pre>
* public Object XXXMethod1(Name name, ...) { * public Object XXXMethod1(Name name, ...) {
* throws NamingException { * throws NamingException {
* return getURLOrDefaultInitXXXCtx(name).XXXMethod1(name, ...); * return getURLOrDefaultInitXXXCtx(name).XXXMethod1(name, ...);
......
...@@ -156,7 +156,7 @@ public abstract class ReferralException extends NamingException { ...@@ -156,7 +156,7 @@ public abstract class ReferralException extends NamingException {
* <code>getReferralContext</code> to allow the processing of * <code>getReferralContext</code> to allow the processing of
* other referrals to continue. * other referrals to continue.
* The following code fragment shows a typical usage pattern. * The following code fragment shows a typical usage pattern.
* <p><blockquote><pre> * <blockquote><pre>
* } catch (ReferralException e) { * } catch (ReferralException e) {
* if (!shallIFollow(e.getReferralInfo())) { * if (!shallIFollow(e.getReferralInfo())) {
* if (!e.skipReferral()) { * if (!e.skipReferral()) {
...@@ -177,7 +177,7 @@ public abstract class ReferralException extends NamingException { ...@@ -177,7 +177,7 @@ public abstract class ReferralException extends NamingException {
* <code>getReferralContext</code> to allow the current * <code>getReferralContext</code> to allow the current
* referral to be retried. * referral to be retried.
* The following code fragment shows a typical usage pattern. * The following code fragment shows a typical usage pattern.
* <p><blockquote><pre> * <blockquote><pre>
* } catch (ReferralException e) { * } catch (ReferralException e) {
* while (true) { * while (true) {
* try { * try {
......
...@@ -31,7 +31,7 @@ import javax.naming.*; ...@@ -31,7 +31,7 @@ import javax.naming.*;
* The directory service interface, containing * The directory service interface, containing
* methods for examining and updating attributes * methods for examining and updating attributes
* associated with objects, and for searching the directory. * associated with objects, and for searching the directory.
* <p> *
* <h1>Names</h1> * <h1>Names</h1>
* Each name passed as an argument to a <tt>DirContext</tt> method is relative * Each name passed as an argument to a <tt>DirContext</tt> method is relative
* to that context. The empty name is used to name the context itself. * to that context. The empty name is used to name the context itself.
...@@ -50,7 +50,7 @@ import javax.naming.*; ...@@ -50,7 +50,7 @@ import javax.naming.*;
* See <tt>Context</tt> for a discussion on the interpretation of the * See <tt>Context</tt> for a discussion on the interpretation of the
* name argument to the <tt>Context</tt> methods. These same rules * name argument to the <tt>Context</tt> methods. These same rules
* apply to the name argument to the <tt>DirContext</tt> methods. * apply to the name argument to the <tt>DirContext</tt> methods.
* <p> *
* <h1>Attribute Models</h1> * <h1>Attribute Models</h1>
* There are two basic models of what attributes should be * There are two basic models of what attributes should be
* associated with. First, attributes may be directly associated with a * associated with. First, attributes may be directly associated with a
...@@ -80,7 +80,7 @@ import javax.naming.*; ...@@ -80,7 +80,7 @@ import javax.naming.*;
* JNDI clients are safest when they do not make assumptions about * JNDI clients are safest when they do not make assumptions about
* whether an object's attributes are stored as part of the object, or stored * whether an object's attributes are stored as part of the object, or stored
* within the parent object and associated with the object's name. * within the parent object and associated with the object's name.
* <p> *
* <h1>Attribute Type Names</h1> * <h1>Attribute Type Names</h1>
* In the <tt>getAttributes()</tt> and <tt>search()</tt> methods, * In the <tt>getAttributes()</tt> and <tt>search()</tt> methods,
* you can supply the attributes to return by supplying a list of * you can supply the attributes to return by supplying a list of
...@@ -112,7 +112,7 @@ import javax.naming.*; ...@@ -112,7 +112,7 @@ import javax.naming.*;
* <li>description;lang-fr * <li>description;lang-fr
* </ul> * </ul>
* *
* <p> *
*<h1>Operational Attributes</h1> *<h1>Operational Attributes</h1>
*<p> *<p>
* Some directories have the notion of "operational attributes" which are * Some directories have the notion of "operational attributes" which are
...@@ -126,7 +126,7 @@ import javax.naming.*; ...@@ -126,7 +126,7 @@ import javax.naming.*;
* The attributes returned do <em>not</em> include operational attributes. * The attributes returned do <em>not</em> include operational attributes.
* In order to retrieve operational attributes, you must name them explicitly. * In order to retrieve operational attributes, you must name them explicitly.
* *
* <p> *
* <h1>Named Context</h1> * <h1>Named Context</h1>
* <p> * <p>
* There are certain methods in which the name must resolve to a context * There are certain methods in which the name must resolve to a context
...@@ -137,7 +137,7 @@ import javax.naming.*; ...@@ -137,7 +137,7 @@ import javax.naming.*;
* <code>NotContextException</code> is thrown. * <code>NotContextException</code> is thrown.
* Aside from these methods, there is no requirement that the * Aside from these methods, there is no requirement that the
* <em>named object</em> be a DirContext. * <em>named object</em> be a DirContext.
*<p> *
*<h1>Parameters</h1> *<h1>Parameters</h1>
*<p> *<p>
* An <tt>Attributes</tt>, <tt>SearchControls</tt>, or array object * An <tt>Attributes</tt>, <tt>SearchControls</tt>, or array object
...@@ -149,7 +149,7 @@ import javax.naming.*; ...@@ -149,7 +149,7 @@ import javax.naming.*;
* An <tt>Attributes</tt> object returned by any method is owned by * An <tt>Attributes</tt> object returned by any method is owned by
* the caller. The caller may subsequently modify it; the service * the caller. The caller may subsequently modify it; the service
* provider will not. * provider will not.
*<p> *
*<h1>Exceptions</h1> *<h1>Exceptions</h1>
*<p> *<p>
* All the methods in this interface can throw a NamingException or * All the methods in this interface can throw a NamingException or
......
...@@ -33,7 +33,7 @@ import javax.naming.NamingException; ...@@ -33,7 +33,7 @@ import javax.naming.NamingException;
/** /**
* Contains methods for registering/deregistering listeners to be notified of * Contains methods for registering/deregistering listeners to be notified of
* events fired when objects named in a context changes. * events fired when objects named in a context changes.
*<p> *
*<h1>Target</h1> *<h1>Target</h1>
* The name parameter in the <tt>addNamingListener()</tt> methods is referred * The name parameter in the <tt>addNamingListener()</tt> methods is referred
* to as the <em>target</em>. The target, along with the scope, identify * to as the <em>target</em>. The target, along with the scope, identify
...@@ -58,7 +58,7 @@ import javax.naming.NamingException; ...@@ -58,7 +58,7 @@ import javax.naming.NamingException;
* An application can use the method <tt>targetMustExist()</tt> to check * An application can use the method <tt>targetMustExist()</tt> to check
* whether a <tt>EventContext</tt> supports registration * whether a <tt>EventContext</tt> supports registration
* of nonexistent targets. * of nonexistent targets.
*<p> *
*<h1>Event Source</h1> *<h1>Event Source</h1>
* The <tt>EventContext</tt> instance on which you invoke the * The <tt>EventContext</tt> instance on which you invoke the
* registration methods is the <em>event source</em> of the events that are * registration methods is the <em>event source</em> of the events that are
......
...@@ -338,7 +338,7 @@ public interface LdapContext extends DirContext { ...@@ -338,7 +338,7 @@ public interface LdapContext extends DirContext {
* parameter, a system property, or one or more resource files. * parameter, a system property, or one or more resource files.
*<p> *<p>
* The value of this constant is "java.naming.factory.control". * The value of this constant is "java.naming.factory.control".
*<p> *
* @see ControlFactory * @see ControlFactory
* @see javax.naming.Context#addToEnvironment * @see javax.naming.Context#addToEnvironment
* @see javax.naming.Context#removeFromEnvironment * @see javax.naming.Context#removeFromEnvironment
......
/* /*
* Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
...@@ -315,7 +315,6 @@ public class Rdn implements Serializable, Comparable<Object> { ...@@ -315,7 +315,6 @@ public class Rdn implements Serializable, Comparable<Object> {
* @return A negative integer, zero, or a positive integer as this Rdn * @return A negative integer, zero, or a positive integer as this Rdn
* is less than, equal to, or greater than the given Object. * is less than, equal to, or greater than the given Object.
* @exception ClassCastException if obj is null or not a Rdn. * @exception ClassCastException if obj is null or not a Rdn.
* <p>
*/ */
public int compareTo(Object obj) { public int compareTo(Object obj) {
if (!(obj instanceof Rdn)) { if (!(obj instanceof Rdn)) {
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册