--- old/src/java.naming/share/classes/javax/naming/directory/DirContext.java 2015-08-04 13:14:39.076900495 +0300 +++ new/src/java.naming/share/classes/javax/naming/directory/DirContext.java 2015-08-04 13:14:38.684900487 +0300 @@ -33,7 +33,7 @@ * associated with objects, and for searching the directory. * *
@@ -47,9 +47,9 @@ * 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 @@ * *
- * 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 @@
* If attempting to add more than one value to a single-valued attribute,
* throws InvalidAttributeValueException
.
*
- * The value of this constant is 1.
+ * The value of this constant is {@code 1}.
*
* @see ModificationItem
* @see #modifyAttributes
@@ -273,7 +273,7 @@
* attempting to add more than one value to a single-valued attribute,
* throws InvalidAttributeValueException
.
*
- * The value of this constant is 2. + * The value of this constant is {@code 2}. * * @see ModificationItem * @see #modifyAttributes @@ -294,7 +294,7 @@ * 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 @@ /** * 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 @@ /** * 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 @@ * 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 @@ * "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 @@
* 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 @@
* @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 @@
* substring comparison) use the version of the search
* method that takes a filter argument.
*
- * 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 @@
* 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 @@
* @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 @@
* @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 @@
*
- * 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 @@
* @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
* attributesToReturn
* and the name of the corresponding object, named relative
* to the context named by name
.
@@ -709,7 +709,7 @@
* 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 @@
* 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 @@
* 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 @@
* 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 @@
* @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 NamingEnumeration