Fix OPENDJ-1276: ModifyDNRequest javadoc should describe deleteOldRDN defau...

Matthew Swift

24.45.2014 7489a42782c83aa0fdc5eabf050daa94e5cf2e19

Fix OPENDJ-1276: ModifyDNRequest javadoc should describe deleteOldRDN default value

Minor Javadoc improvements: document default values for deleteOldRDN and newSuperior for modify DN operations.

 opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/ModifyDNRequest.java

@@ -83,7 +83,9 @@
    /**
     * Returns the distinguished name of an existing entry that will become the
     * immediate superior (parent) of the entry to be renamed. The server shall
     * not dereference any aliases in locating the new superior entry.
     * not dereference any aliases in locating the new superior entry. The
     * default value is {@code null}, indicating that the entry is to remain
     * under the same parent entry.
     *
     * @return The distinguished name of the new superior entry, or {@code null}
     *         if the entry is to remain under the same parent entry.
@@ -92,7 +94,8 @@

    /**
     * Indicates whether the old RDN attribute values are to be retained as
     * attributes of the entry or deleted from the entry.
     * attributes of the entry or deleted from the entry. The default value is
     * {@code false}.
     *
     * @return {@code true} if the old RDN attribute values are to be deleted
     *         from the entry, or {@code false} if they are to be retained.
@@ -101,7 +104,8 @@

    /**
     * Specifies whether the old RDN attribute values are to be retained as
     * attributes of the entry or deleted from the entry.
     * attributes of the entry or deleted from the entry. The default value is
     * {@code false}.
     *
     * @param deleteOldRDN
     *            {@code true} if the old RDN attribute values are to be deleted
@@ -188,7 +192,9 @@
    /**
     * Sets the distinguished name of an existing entry that will become the
     * immediate superior (parent) of the entry to be renamed. The server shall
     * not dereference any aliases in locating the new superior entry.
     * not dereference any aliases in locating the new superior entry. The
     * default value is {@code null}, indicating that the entry is to remain
     * under the same parent entry.
     *
     * @param dn
     *            The distinguished name of an existing entry that will become
@@ -204,7 +210,9 @@
    /**
     * Sets the distinguished name of an existing entry that will become the
     * immediate superior (parent) of the entry to be renamed. The server shall
     * not dereference any aliases in locating the new superior entry.
     * not dereference any aliases in locating the new superior entry. The
     * default value is {@code null}, indicating that the entry is to remain
     * under the same parent entry.
     *
     * @param dn
     *            The distinguished name of an existing entry that will become

 opendj-core/src/main/java/org/forgerock/opendj/ldap/requests/Requests.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2010 Sun Microsystems, Inc.
 *      Portions copyright 2011-2013 ForgeRock AS
 *      Portions copyright 2011-2014 ForgeRock AS
 */

package org.forgerock.opendj.ldap.requests;
@@ -835,7 +835,9 @@

    /**
     * Creates a new modify DN request using the provided distinguished name and
     * new RDN.
     * new RDN. The new superior will be {@code null}, indicating that the
     * renamed entry will remain under the same parent entry, and the old RDN
     * attribute values will not be deleted.
     *
     * @param name
     *            The distinguished name of the entry to be renamed.
@@ -853,7 +855,9 @@

    /**
     * Creates a new modify DN request using the provided distinguished name and
     * new RDN decoded using the default schema.
     * new RDN decoded using the default schema. The new superior will be
     * {@code null}, indicating that the renamed entry will remain under the
     * same parent entry, and the old RDN attribute values will not be deleted.
     *
     * @param name
     *            The distinguished name of the entry to be renamed.