# HG changeset patch # User darcy # Date 1382073734 25200 # Node ID e740104a04f19e05a7fcfa64a27b79e3c7887f73 # Parent e6dfe841a88fe9a576f92f5ce6a742fc8e207dea 8026840: Fix new doclint issues in javax.naming Reviewed-by: mchung diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/CompositeName.java --- a/jdk/src/share/classes/javax/naming/CompositeName.java Thu Oct 17 19:47:47 2013 -0700 +++ b/jdk/src/share/classes/javax/naming/CompositeName.java Thu Oct 17 22:22:14 2013 -0700 @@ -41,7 +41,7 @@ * This range may be written as [0,N). * The most significant component is at index 0. * An empty composite name has no components. - *

+ * *

JNDI Composite Name Syntax

* JNDI defines a standard string representation for composite names. This * representation is the concatenation of the components of a composite name @@ -72,12 +72,12 @@ * A trailing component separator (the composite name string ends with * a separator) denotes a trailing empty component. * Adjacent component separators denote an empty component. - *

+ * *

Composite Name Examples

*This table shows examples of some composite names. Each row shows *the string form of a composite name and its corresponding structural form *(CompositeName). - *

+ * @@ -136,7 +136,7 @@
{"x", "", "y"}
- *

+ * *

Composition Examples

* Here are some composition examples. The right column shows composing * string composite names while the left column shows composing the @@ -144,7 +144,7 @@ * string forms of two composite names simply involves concatenating * their string forms together. -

+
@@ -188,7 +188,7 @@
String Names
- *

+ * *

Multithreaded Access

* A CompositeName instance is not synchronized against concurrent * multithreaded access. Multiple threads trying to access and modify a diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/CompoundName.java --- a/jdk/src/share/classes/javax/naming/CompoundName.java Thu Oct 17 19:47:47 2013 -0700 +++ b/jdk/src/share/classes/javax/naming/CompoundName.java Thu Oct 17 22:22:14 2013 -0700 @@ -38,7 +38,7 @@ * This range may be written as [0,N). * The most significant component is at index 0. * An empty compound name has no components. - *

+ * *

Compound Name Syntax

* The syntax of a compound name is specified using a set of properties: *
@@ -135,7 +135,7 @@ * applied (e.g. embedded separators are escaped or quoted) * so that when the same string is parsed, it will yield the same components * of the original compound name. - *

+ * *

Multithreaded Access

* A CompoundName instance is not synchronized against concurrent * multithreaded access. Multiple threads trying to access and modify a diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/Context.java --- a/jdk/src/share/classes/javax/naming/Context.java Thu Oct 17 19:47:47 2013 -0700 +++ b/jdk/src/share/classes/javax/naming/Context.java Thu Oct 17 22:22:14 2013 -0700 @@ -31,7 +31,7 @@ * This interface represents a naming context, which * consists of a set of name-to-object bindings. * It contains methods for examining and updating these bindings. - *

+ * *

Names

* Each name passed as an argument to a Context method is relative * to that context. The empty name is used to name the context itself. @@ -68,12 +68,12 @@ * NamingEnumeration may be names in their own namespace rather than * names in a composite namespace, at the discretion of the service * provider. - *

+ * *

Exceptions

* All the methods in this interface can throw a NamingException or * any of its subclasses. See NamingException and their subclasses * for details on each exception. - *

+ * *

Concurrent Access

* A Context instance is not guaranteed to be synchronized against * concurrent access by multiple threads. Threads that need to access @@ -90,7 +90,7 @@ * use, or while any referrals generated by that operation are still * being followed. * - *

+ * *

Parameters

* A Name parameter passed to any method of the * Context interface or one of its subinterfaces @@ -102,7 +102,7 @@ * A Name returned by any such method is owned by the caller. * The caller may subsequently modify it; the service provider may not. * - *

+ * *

Environment Properties

*

* JNDI applications need a way to communicate various preferences diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/InitialContext.java --- a/jdk/src/share/classes/javax/naming/InitialContext.java Thu Oct 17 19:47:47 2013 -0700 +++ b/jdk/src/share/classes/javax/naming/InitialContext.java Thu Oct 17 22:22:14 2013 -0700 @@ -361,7 +361,7 @@ * follows. * Define a new method that uses this method to get an initial * context of the desired subclass. - *

+     * 
      * protected XXXContext getURLOrDefaultInitXXXCtx(Name name)
      * throws NamingException {
      *  Context answer = getURLOrDefaultInitCtx(name);
@@ -377,7 +377,7 @@
      * 
* When providing implementations for the new methods in the subclass, * use this newly defined method to get the initial context. - *

+     * 
      * public Object XXXMethod1(Name name, ...) {
      *  throws NamingException {
      *    return getURLOrDefaultInitXXXCtx(name).XXXMethod1(name, ...);
diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/ReferralException.java
--- a/jdk/src/share/classes/javax/naming/ReferralException.java	Thu Oct 17 19:47:47 2013 -0700
+++ b/jdk/src/share/classes/javax/naming/ReferralException.java	Thu Oct 17 22:22:14 2013 -0700
@@ -156,7 +156,7 @@
      * getReferralContext to allow the processing of
      * other referrals to continue.
      * The following code fragment shows a typical usage pattern.
-     * 

+     * 
      *  } catch (ReferralException e) {
      *      if (!shallIFollow(e.getReferralInfo())) {
      *          if (!e.skipReferral()) {
@@ -177,7 +177,7 @@
      * getReferralContext to allow the current
      * referral to be retried.
      * The following code fragment shows a typical usage pattern.
-     * 

+     * 
      *  } catch (ReferralException e) {
      *      while (true) {
      *          try {
diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/directory/DirContext.java
--- a/jdk/src/share/classes/javax/naming/directory/DirContext.java	Thu Oct 17 19:47:47 2013 -0700
+++ b/jdk/src/share/classes/javax/naming/directory/DirContext.java	Thu Oct 17 22:22:14 2013 -0700
@@ -31,7 +31,7 @@
  * The directory service interface, containing
  * methods for examining and updating attributes
  * associated with objects, and for searching the directory.
- * 

+ * *

Names

* Each name passed as an argument to a DirContext method is relative * to that context. The empty name is used to name the context itself. @@ -50,7 +50,7 @@ * 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. - *

+ * *

Attribute Models

* There are two basic models of what attributes should be * associated with. First, attributes may be directly associated with a @@ -80,7 +80,7 @@ * 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 * within the parent object and associated with the object's name. - *

+ * *

Attribute Type Names

* In the getAttributes() and search() methods, * you can supply the attributes to return by supplying a list of @@ -112,7 +112,7 @@ *
  • description;lang-fr * * - *

    + * *

    Operational Attributes

    *

    * Some directories have the notion of "operational attributes" which are @@ -126,7 +126,7 @@ * The attributes returned do not include operational attributes. * In order to retrieve operational attributes, you must name them explicitly. * - *

    + * *

    Named Context

    *

    * There are certain methods in which the name must resolve to a context @@ -137,7 +137,7 @@ * NotContextException is thrown. * Aside from these methods, there is no requirement that the * named object be a DirContext. - *

    + * *

    Parameters

    *

    * An Attributes, SearchControls, or array object @@ -149,7 +149,7 @@ * An Attributes object returned by any method is owned by * the caller. The caller may subsequently modify it; the service * provider will not. - *

    + * *

    Exceptions

    *

    * All the methods in this interface can throw a NamingException or diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/event/EventContext.java --- a/jdk/src/share/classes/javax/naming/event/EventContext.java Thu Oct 17 19:47:47 2013 -0700 +++ b/jdk/src/share/classes/javax/naming/event/EventContext.java Thu Oct 17 22:22:14 2013 -0700 @@ -33,7 +33,7 @@ /** * Contains methods for registering/deregistering listeners to be notified of * events fired when objects named in a context changes. - *

    + * *

    Target

    * The name parameter in the addNamingListener() methods is referred * to as the target. The target, along with the scope, identify @@ -58,7 +58,7 @@ * An application can use the method targetMustExist() to check * whether a EventContext supports registration * of nonexistent targets. - *

    + * *

    Event Source

    * The EventContext instance on which you invoke the * registration methods is the event source of the events that are diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/ldap/LdapContext.java --- a/jdk/src/share/classes/javax/naming/ldap/LdapContext.java Thu Oct 17 19:47:47 2013 -0700 +++ b/jdk/src/share/classes/javax/naming/ldap/LdapContext.java Thu Oct 17 22:22:14 2013 -0700 @@ -338,7 +338,7 @@ * parameter, a system property, or one or more resource files. *

    * The value of this constant is "java.naming.factory.control". - *

    + * * @see ControlFactory * @see javax.naming.Context#addToEnvironment * @see javax.naming.Context#removeFromEnvironment diff -r e6dfe841a88f -r e740104a04f1 jdk/src/share/classes/javax/naming/ldap/Rdn.java --- a/jdk/src/share/classes/javax/naming/ldap/Rdn.java Thu Oct 17 19:47:47 2013 -0700 +++ b/jdk/src/share/classes/javax/naming/ldap/Rdn.java Thu Oct 17 22:22:14 2013 -0700 @@ -1,5 +1,5 @@ /* - * 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. * * This code is free software; you can redistribute it and/or modify it @@ -315,7 +315,6 @@ * @return A negative integer, zero, or a positive integer as this Rdn * is less than, equal to, or greater than the given Object. * @exception ClassCastException if obj is null or not a Rdn. - *

    */ public int compareTo(Object obj) { if (!(obj instanceof Rdn)) {