8220252: Fix Headings in java.naming
authorlancea
Thu, 14 Mar 2019 10:50:35 -0400
changeset 54126 478f1483c511
parent 54125 70a818b1d9db
child 54127 e6a1c4e28294
8220252: Fix Headings in java.naming Reviewed-by: dfuchs
src/java.naming/share/classes/com/sun/jndi/ldap/EventSupport.java
src/java.naming/share/classes/javax/naming/CompositeName.java
src/java.naming/share/classes/javax/naming/CompoundName.java
src/java.naming/share/classes/javax/naming/Context.java
src/java.naming/share/classes/javax/naming/directory/DirContext.java
src/java.naming/share/classes/javax/naming/event/EventContext.java
src/java.naming/share/classes/javax/naming/ldap/LdapContext.java
--- a/src/java.naming/share/classes/com/sun/jndi/ldap/EventSupport.java	Thu Mar 14 15:31:13 2019 +0100
+++ b/src/java.naming/share/classes/com/sun/jndi/ldap/EventSupport.java	Thu Mar 14 10:50:35 2019 -0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2019, 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
@@ -78,20 +78,20 @@
  *When a context no longer needs this EventSupport, it should invoke
  *cleanup() on it.
  *<p>
- *<h4>Registration</h4>
+ *<h2>Registration</h2>
  *When a registration request is made, this class attempts to find an
  *existing notifier that's already working on the request. If one is
  *found, the listener is added to the notifier's list. If one is not found,
  *a new notifier is created for the listener.
  *
- *<h4>Deregistration</h4>
+ *<h2>Deregistration</h2>
  *When a deregistration request is made, this class attempts to find its
  *corresponding notifier. If the notifier is found, the listener is removed
  *from the notifier's list. If the listener is the last listener on the list,
  *the notifier's thread is terminated and removed from this class's hashtable.
  *Nothing happens if the notifier is not found.
  *
- *<h4>Event Dispatching</h4>
+ *<h2>Event Dispatching</h2>
  *The notifiers are responsible for gather information for generating events
  *requested by their respective listeners. When a notifier gets sufficient
  *information to generate an event, it creates invokes the
@@ -101,7 +101,7 @@
  *This class maintains an event queue and a dispatching thread that dequeues
  *events from the queue and dispatches them to the listeners.
  *
- *<h4>Synchronization</h4>
+ *<h2>Synchronization</h2>
  *This class is used by the main thread (LdapCtx) to add/remove listeners.
  *It is also used asynchronously by NamingEventNotifiers threads and
  *the context's Connection thread. It is used by the notifier threads to
--- a/src/java.naming/share/classes/javax/naming/CompositeName.java	Thu Mar 14 15:31:13 2019 +0100
+++ b/src/java.naming/share/classes/javax/naming/CompositeName.java	Thu Mar 14 10:50:35 2019 -0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2019, 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
@@ -42,7 +42,7 @@
  * The most significant component is at index 0.
  * An empty composite name has no components.
  *
- * <h1>JNDI Composite Name Syntax</h1>
+ * <h2>JNDI Composite Name Syntax</h2>
  * JNDI defines a standard string representation for composite names. This
  * representation is the concatenation of the components of a composite name
  * from left to right using the component separator (a forward
@@ -73,7 +73,7 @@
  * a separator) denotes a trailing empty component.
  * Adjacent component separators denote an empty component.
  *
- *<h1>Composite Name Examples</h1>
+ *<h2>Composite Name Examples</h2>
  *This table shows examples of some composite names. Each row shows
  *the string form of a composite name and its corresponding structural form
  *({@code CompositeName}).
@@ -140,7 +140,7 @@
 </tbody>
 </table>
  *
- *<h1>Composition Examples</h1>
+ *<h2>Composition Examples</h2>
  * Here are some composition examples.  The right column shows composing
  * string composite names while the left column shows composing the
  * corresponding {@code CompositeName}s.  Notice that composing the
@@ -195,7 +195,7 @@
 </tbody>
 </table>
  *
- *<h1>Multithreaded Access</h1>
+ *<h2>Multithreaded Access</h2>
  * A {@code CompositeName} instance is not synchronized against concurrent
  * multithreaded access. Multiple threads trying to access and modify a
  * {@code CompositeName} should lock the object.
--- a/src/java.naming/share/classes/javax/naming/CompoundName.java	Thu Mar 14 15:31:13 2019 +0100
+++ b/src/java.naming/share/classes/javax/naming/CompoundName.java	Thu Mar 14 10:50:35 2019 -0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2019, 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
@@ -39,7 +39,7 @@
  * The most significant component is at index 0.
  * An empty compound name has no components.
  *
- * <h1>Compound Name Syntax</h1>
+ * <h2>Compound Name Syntax</h2>
  * The syntax of a compound name is specified using a set of properties:
  *<dl>
  *  <dt>jndi.syntax.direction
@@ -136,7 +136,7 @@
  * so that when the same string is parsed, it will yield the same components
  * of the original compound name.
  *
- *<h1>Multithreaded Access</h1>
+ *<h2>Multithreaded Access</h2>
  * A {@code CompoundName} instance is not synchronized against concurrent
  * multithreaded access. Multiple threads trying to access and modify a
  * {@code CompoundName} should lock the object.
--- a/src/java.naming/share/classes/javax/naming/Context.java	Thu Mar 14 15:31:13 2019 +0100
+++ b/src/java.naming/share/classes/javax/naming/Context.java	Thu Mar 14 10:50:35 2019 -0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2019, 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
@@ -32,7 +32,7 @@
  * consists of a set of name-to-object bindings.
  * It contains methods for examining and updating these bindings.
  *
- * <h1>Names</h1>
+ * <h2>Names</h2>
  * Each name passed as an argument to a {@code Context} method is relative
  * to that context.  The empty name is used to name the context itself.
  * A name parameter may never be null.
@@ -69,12 +69,12 @@
  * names in a composite namespace, at the discretion of the service
  * provider.
  *
- *<h1>Exceptions</h1>
+ *<h2>Exceptions</h2>
  * All the methods in this interface can throw a {@code NamingException} or
  * any of its subclasses. See {@code NamingException} and their subclasses
  * for details on each exception.
  *
- *<h1>Concurrent Access</h1>
+ *<h2>Concurrent Access</h2>
  * A Context instance is not guaranteed to be synchronized against
  * concurrent access by multiple threads.  Threads that need to access
  * a single Context instance concurrently should synchronize amongst
@@ -91,7 +91,7 @@
  * being followed.
  *
  *
- *<h1>Parameters</h1>
+ *<h2>Parameters</h2>
  * A {@code Name} parameter passed to any method of the
  * {@code Context} interface or one of its subinterfaces
  * will not be modified by the service provider.
@@ -103,7 +103,7 @@
  * The caller may subsequently modify it; the service provider may not.
  *
  *
- *<h1>Environment Properties</h1>
+ *<h2>Environment Properties</h2>
  *<p>
  * JNDI applications need a way to communicate various preferences
  * and properties that define the environment in which naming and
@@ -138,7 +138,7 @@
  *
  *<p>
  *<a id=RESOURCEFILES></a>
- *<h1>Resource Files</h1>
+ *<h2>Resource Files</h2>
  *<p>
  * To simplify the task of setting up the environment
  * required by a JNDI application,
@@ -165,7 +165,7 @@
  * There are two kinds of JNDI resource files:
  * <em>provider</em> and <em>application</em>.
  *
- * <h2>Provider Resource Files</h2>
+ * <h3>Provider Resource Files</h3>
  *
  * Each service provider has an optional resource that lists properties
  * specific to that provider.  The name of this resource is:
@@ -200,7 +200,7 @@
  * The service provider's documentation should clearly state which
  * properties are allowed; other properties in the file will be ignored.
  *
- * <h2>Application Resource Files</h2>
+ * <h3>Application Resource Files</h3>
  *
  * When an application is deployed, it will generally have several
  * codebase directories and JARs in its classpath. JNDI locates (using
@@ -228,7 +228,7 @@
  * collects and uses all of these export lists when searching for factory
  * classes.
  *
- * <h2>Search Algorithm for Properties</h2>
+ * <h3>Search Algorithm for Properties</h3>
  *
  * When JNDI constructs an initial context, the context's environment
  * is initialized with properties defined in the environment parameter
--- a/src/java.naming/share/classes/javax/naming/directory/DirContext.java	Thu Mar 14 15:31:13 2019 +0100
+++ b/src/java.naming/share/classes/javax/naming/directory/DirContext.java	Thu Mar 14 10:50:35 2019 -0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2019, 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
@@ -32,7 +32,7 @@
  * methods for examining and updating attributes
  * associated with objects, and for searching the directory.
  *
- * <h1>Names</h1>
+ * <h2>Names</h2>
  * 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.
@@ -51,7 +51,7 @@
  * name argument to the {@code Context} methods. These same rules
  * apply to the name argument to the {@code DirContext} methods.
  *
- * <h1>Attribute Models</h1>
+ * <h2>Attribute Models</h2>
  * There are two basic models of what attributes should be
  * associated with.  First, attributes may be directly associated with a
  * DirContext object.
@@ -81,7 +81,7 @@
  * 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.
  *
- * <h1>Attribute Type Names</h1>
+ * <h2>Attribute Type Names</h2>
  * In the {@code getAttributes()} and {@code search()} methods,
  * you can supply the attributes to return by supplying a list of
  * attribute names (strings).
@@ -113,7 +113,7 @@
  * </ul>
  *
  *
- *<h1>Operational Attributes</h1>
+ *<h2>Operational Attributes</h2>
  *<p>
  * Some directories have the notion of "operational attributes" which are
  * attributes associated with a directory object for administrative
@@ -127,7 +127,7 @@
  * In order to retrieve operational attributes, you must name them explicitly.
  *
  *
- * <h1>Named Context</h1>
+ * <h2>Named Context</h2>
  * <p>
  * There are certain methods in which the name must resolve to a context
  * (for example, when searching a single level context). The documentation
@@ -138,7 +138,7 @@
  * Aside from these methods, there is no requirement that the
  * <em>named object</em> be a DirContext.
  *
- *<h1>Parameters</h1>
+ *<h2>Parameters</h2>
  *<p>
  * An {@code Attributes}, {@code SearchControls}, or array object
  * passed as a parameter to any method will not be modified by the
@@ -150,7 +150,7 @@
  * the caller.  The caller may subsequently modify it; the service
  * provider will not.
  *
- *<h1>Exceptions</h1>
+ *<h2>Exceptions</h2>
  *<p>
  * All the methods in this interface can throw a NamingException or
  * any of its subclasses. See NamingException and their subclasses
--- a/src/java.naming/share/classes/javax/naming/event/EventContext.java	Thu Mar 14 15:31:13 2019 +0100
+++ b/src/java.naming/share/classes/javax/naming/event/EventContext.java	Thu Mar 14 10:50:35 2019 -0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2019, 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
@@ -34,7 +34,7 @@
  * Contains methods for registering/deregistering listeners to be notified of
  * events fired when objects named in a context changes.
  *
- *<h1>Target</h1>
+ *<h2>Target</h2>
  * The name parameter in the {@code addNamingListener()} methods is referred
  * to as the <em>target</em>. The target, along with the scope, identify
  * the object(s) that the listener is interested in.
@@ -59,7 +59,7 @@
  * whether an {@code EventContext} supports registration
  * of nonexistent targets.
  *
- *<h1>Event Source</h1>
+ *<h2>Event Source</h2>
  * The {@code EventContext} instance on which you invoke the
  * registration methods is the <em>event source</em> of the events that are
  * (potentially) generated.
@@ -93,7 +93,7 @@
  * it needs to keep a reference to the listener in order to remove it
  * later). It cannot expect to do a {@code lookup()} and get another instance of
  * an {@code EventContext} on which to perform the deregistration.
- *<h1>Lifetime of Registration</h1>
+ *<h2>Lifetime of Registration</h2>
  * A registered listener becomes deregistered when:
  *<ul>
  *<li>It is removed using {@code removeNamingListener()}.
@@ -105,7 +105,7 @@
  * Until that point, an {@code EventContext} instance that has outstanding
  * listeners will continue to exist and be maintained by the service provider.
  *
- *<h1>Listener Implementations</h1>
+ *<h2>Listener Implementations</h2>
  * The registration/deregistration methods accept an instance of
  * {@code NamingListener}. There are subinterfaces of {@code NamingListener}
  * for different of event types of {@code NamingEvent}.
@@ -118,7 +118,7 @@
  * of the listeners, this allows some service providers to optimize the
  * registration.
  *
- *<h1>Threading Issues</h1>
+ *<h2>Threading Issues</h2>
  *
  * Like {@code Context} instances in general, instances of
  * {@code EventContext} are not guaranteed to be thread-safe.
--- a/src/java.naming/share/classes/javax/naming/ldap/LdapContext.java	Thu Mar 14 15:31:13 2019 +0100
+++ b/src/java.naming/share/classes/javax/naming/ldap/LdapContext.java	Thu Mar 14 10:50:35 2019 -0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2019, 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
@@ -38,7 +38,7 @@
  * operations, the more generic {@code javax.naming.directory.DirContext}
  * should be used instead.
  *
- * <h3>Usage Details About Controls</h3>
+ * <h2>Usage Details About Controls</h2>
  *
  * This interface provides support for LDAP v3 controls.
  * At a high level, this support allows a user
@@ -50,7 +50,7 @@
  * both the user program and service providers need to understand in order
  * to correctly use request and response controls.
  *
- * <h3>Request Controls</h3>
+ * <h2>Request Controls</h2>
  * <p>
  * There are two types of request controls:
  * <ul>
@@ -75,7 +75,7 @@
  *<p>Unless explicitly qualified, the term "request controls" refers to
  * context request controls.
  *
- * <h4>Context Request Controls</h4>
+ * <h3>Context Request Controls</h3>
  * There are two ways in which a context instance gets its request controls:
  * <ol>
  * <li><code>ldapContext.newInstance(<strong>reqCtls</strong>)</code>
@@ -97,7 +97,7 @@
  * A context instance's request controls are retrieved using
  * the method {@code getRequestControls()}.
  *
- * <h4>Connection Request Controls</h4>
+ * <h3>Connection Request Controls</h3>
  * There are three ways in which connection request controls are set:
  * <ol>
  * <li><code>
@@ -133,7 +133,7 @@
  * A context instance's connection request controls are retrieved using
  * the method {@code getConnectControls()}.
  *
- * <h4>Service Provider Requirements</h4>
+ * <h3>Service Provider Requirements</h3>
  *
  * A service provider supports connection and context request controls
  * in the following ways.  Context request controls must be associated on
@@ -143,7 +143,7 @@
  * property "java.naming.ldap.control.connect" and pass this environment
  * property on to context instances that it creates.
  *
- * <h3>Response Controls</h3>
+ * <h2>Response Controls</h2>
  *
  * The method {@code LdapContext.getResponseControls()} is used to
  * retrieve the response controls generated by LDAP operations executed
@@ -153,7 +153,7 @@
  * To get only the reconnection response controls,
  * use {@code reconnect()} followed by {@code getResponseControls()}.
  *
- * <h3>Parameters</h3>
+ * <h2>Parameters</h2>
  *
  * A {@code Control[]} array
  * passed as a parameter to any method is owned by the caller.