From 263d085885df024dca9250cc03c807912b0a7662 Mon Sep 17 00:00:00 2001
From: Matthew Swift <matthew.swift@forgerock.com>
Date: Tue, 24 Apr 2012 22:33:21 +0000
Subject: [PATCH] Reformat to comply with new Checkstyle rules.
---
opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/requests/ModifyDNRequest.java | 376 ++++++++++++++++++++++++-----------------------------
1 files changed, 172 insertions(+), 204 deletions(-)
diff --git a/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/requests/ModifyDNRequest.java b/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/requests/ModifyDNRequest.java
index 60d3d4c..86ad5d0 100644
--- a/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/requests/ModifyDNRequest.java
+++ b/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/requests/ModifyDNRequest.java
@@ -6,17 +6,16 @@
* (the "License"). You may not use this file except in compliance
* with the License.
*
- * You can obtain a copy of the license at
- * trunk/opendj3/legal-notices/CDDLv1_0.txt
+ * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* or http://forgerock.org/license/CDDLv1.0.html.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
- * file and include the License file at
- * trunk/opendj3/legal-notices/CDDLv1_0.txt. If applicable,
- * add the following below this CDDL HEADER, with the fields enclosed
- * by brackets "[]" replaced with your own identifying information:
+ * file and include the License file at legal-notices/CDDLv1_0.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
@@ -28,11 +27,9 @@
package org.forgerock.opendj.ldap.requests;
-
-
import java.util.List;
-import org.forgerock.i18n.*;
+import org.forgerock.i18n.LocalizedIllegalArgumentException;
import org.forgerock.opendj.ldap.DN;
import org.forgerock.opendj.ldap.DecodeException;
import org.forgerock.opendj.ldap.DecodeOptions;
@@ -42,219 +39,190 @@
import org.forgerock.opendj.ldif.ChangeRecord;
import org.forgerock.opendj.ldif.ChangeRecordVisitor;
-
-
/**
* The Modify DN operation allows a client to change the Relative Distinguished
* Name (RDN) of an entry in the Directory and/or to move a subtree of entries
* to a new location in the Directory.
*/
-public interface ModifyDNRequest extends Request, ChangeRecord
-{
- /**
- * {@inheritDoc}
- */
- <R, P> R accept(ChangeRecordVisitor<R, P> v, P p);
+public interface ModifyDNRequest extends Request, ChangeRecord {
+ /**
+ * {@inheritDoc}
+ */
+ <R, P> R accept(ChangeRecordVisitor<R, P> v, P p);
+ /**
+ * {@inheritDoc}
+ */
+ ModifyDNRequest addControl(Control control);
+ /**
+ * {@inheritDoc}
+ */
+ <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options)
+ throws DecodeException;
- /**
- * {@inheritDoc}
- */
- ModifyDNRequest addControl(Control control);
+ /**
+ * {@inheritDoc}
+ */
+ List<Control> getControls();
+ /**
+ * Returns the distinguished name of the entry to be renamed. This entry may
+ * or may not have subordinate entries. The server shall not dereference any
+ * aliases in locating the entry to be renamed.
+ *
+ * @return The distinguished name of the entry.
+ */
+ DN getName();
+ /**
+ * Returns the new RDN of the entry to be renamed. The value of the old RDN
+ * is supplied when moving the entry to a new superior without changing its
+ * RDN. Attribute values of the new RDN not matching any attribute value of
+ * the entry are added to the entry, and an appropriate error is returned if
+ * this fails.
+ *
+ * @return The new RDN of the entry.
+ */
+ RDN getNewRDN();
- /**
- * {@inheritDoc}
- */
- <C extends Control> C getControl(ControlDecoder<C> decoder,
- DecodeOptions options) throws DecodeException;
+ /**
+ * 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.
+ *
+ * @return The distinguished name of the new superior entry, or {@code null}
+ * if the entry is to remain under the same parent entry.
+ */
+ DN getNewSuperior();
+ /**
+ * Indicates whether the old RDN attribute values are to be retained as
+ * attributes of the entry or deleted from the entry.
+ *
+ * @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.
+ */
+ boolean isDeleteOldRDN();
+ /**
+ * Specifies whether the old RDN attribute values are to be retained as
+ * attributes of the entry or deleted from the entry.
+ *
+ * @param deleteOldRDN
+ * {@code true} if the old RDN attribute values are to be deleted
+ * from the entry, or {@code false} if they are to be retained.
+ * @return This modify DN request.
+ * @throws UnsupportedOperationException
+ * If this modify DN request does not permit the delete old RDN
+ * parameter to be set.
+ */
+ ModifyDNRequest setDeleteOldRDN(boolean deleteOldRDN);
- /**
- * {@inheritDoc}
- */
- List<Control> getControls();
+ /**
+ * Sets the distinguished name of the entry to be renamed. This entry may or
+ * may not have subordinate entries. The server shall not dereference any
+ * aliases in locating the entry to be renamed.
+ *
+ * @param dn
+ * The distinguished name of the entry to be renamed.
+ * @return This modify DN request.
+ * @throws UnsupportedOperationException
+ * If this modify DN request does not permit the distinguished
+ * name to be set.
+ * @throws NullPointerException
+ * If {@code dn} was {@code null}.
+ */
+ ModifyDNRequest setName(DN dn);
+ /**
+ * Sets the distinguished name of the entry to be renamed. This entry may or
+ * may not have subordinate entries. The server shall not dereference any
+ * aliases in locating the entry to be renamed.
+ *
+ * @param dn
+ * The distinguished name of the entry to be renamed.
+ * @return This modify DN request.
+ * @throws LocalizedIllegalArgumentException
+ * If {@code dn} could not be decoded using the default schema.
+ * @throws UnsupportedOperationException
+ * If this modify DN request does not permit the distinguished
+ * name to be set.
+ * @throws NullPointerException
+ * If {@code dn} was {@code null}.
+ */
+ ModifyDNRequest setName(String dn);
+ /**
+ * Sets the new RDN of the entry to be renamed. The value of the old RDN is
+ * supplied when moving the entry to a new superior without changing its
+ * RDN. Attribute values of the new RDN not matching any attribute value of
+ * the entry are added to the entry, and an appropriate error is returned if
+ * this fails.
+ *
+ * @param rdn
+ * The new RDN of the entry to be renamed.
+ * @return This modify DN request.
+ * @throws UnsupportedOperationException
+ * If this modify DN request does not permit the new RDN to be
+ * set.
+ * @throws NullPointerException
+ * If {@code rdn} was {@code null}.
+ */
+ ModifyDNRequest setNewRDN(RDN rdn);
- /**
- * Returns the distinguished name of the entry to be renamed. This entry may
- * or may not have subordinate entries. The server shall not dereference any
- * aliases in locating the entry to be renamed.
- *
- * @return The distinguished name of the entry.
- */
- DN getName();
+ /**
+ * Sets the new RDN of the entry to be renamed. The value of the old RDN is
+ * supplied when moving the entry to a new superior without changing its
+ * RDN. Attribute values of the new RDN not matching any attribute value of
+ * the entry are added to the entry, and an appropriate error is returned if
+ * this fails.
+ *
+ * @param rdn
+ * The new RDN of the entry to be renamed.
+ * @return This modify DN request.
+ * @throws LocalizedIllegalArgumentException
+ * If {@code rdn} could not be decoded using the default schema.
+ * @throws UnsupportedOperationException
+ * If this modify DN request does not permit the new RDN to be
+ * set.
+ * @throws NullPointerException
+ * If {@code rdn} was {@code null}.
+ */
+ ModifyDNRequest setNewRDN(String rdn);
+ /**
+ * 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.
+ *
+ * @param dn
+ * The distinguished name of an existing entry that will become
+ * the immediate superior (parent) of the entry to be renamed,
+ * may be {@code null}.
+ * @return This modify DN request.
+ * @throws UnsupportedOperationException
+ * If this modify DN request does not permit the new superior to
+ * be set.
+ */
+ ModifyDNRequest setNewSuperior(DN dn);
-
- /**
- * Returns the new RDN of the entry to be renamed. The value of the old RDN is
- * supplied when moving the entry to a new superior without changing its RDN.
- * Attribute values of the new RDN not matching any attribute value of the
- * entry are added to the entry, and an appropriate error is returned if this
- * fails.
- *
- * @return The new RDN of the entry.
- */
- RDN getNewRDN();
-
-
-
- /**
- * 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.
- *
- * @return The distinguished name of the new superior entry, or {@code null}
- * if the entry is to remain under the same parent entry.
- */
- DN getNewSuperior();
-
-
-
- /**
- * Indicates whether the old RDN attribute values are to be retained as
- * attributes of the entry or deleted from the entry.
- *
- * @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.
- */
- boolean isDeleteOldRDN();
-
-
-
- /**
- * Specifies whether the old RDN attribute values are to be retained as
- * attributes of the entry or deleted from the entry.
- *
- * @param deleteOldRDN
- * {@code true} if the old RDN attribute values are to be deleted
- * from the entry, or {@code false} if they are to be retained.
- * @return This modify DN request.
- * @throws UnsupportedOperationException
- * If this modify DN request does not permit the delete old RDN
- * parameter to be set.
- */
- ModifyDNRequest setDeleteOldRDN(boolean deleteOldRDN);
-
-
-
- /**
- * Sets the distinguished name of the entry to be renamed. This entry may or
- * may not have subordinate entries. The server shall not dereference any
- * aliases in locating the entry to be renamed.
- *
- * @param dn
- * The distinguished name of the entry to be renamed.
- * @return This modify DN request.
- * @throws UnsupportedOperationException
- * If this modify DN request does not permit the distinguished name
- * to be set.
- * @throws NullPointerException
- * If {@code dn} was {@code null}.
- */
- ModifyDNRequest setName(DN dn);
-
-
-
- /**
- * Sets the distinguished name of the entry to be renamed. This entry may or
- * may not have subordinate entries. The server shall not dereference any
- * aliases in locating the entry to be renamed.
- *
- * @param dn
- * The distinguished name of the entry to be renamed.
- * @return This modify DN request.
- * @throws LocalizedIllegalArgumentException
- * If {@code dn} could not be decoded using the default schema.
- * @throws UnsupportedOperationException
- * If this modify DN request does not permit the distinguished name
- * to be set.
- * @throws NullPointerException
- * If {@code dn} was {@code null}.
- */
- ModifyDNRequest setName(String dn);
-
-
-
- /**
- * Sets the new RDN of the entry to be renamed. The value of the old RDN is
- * supplied when moving the entry to a new superior without changing its RDN.
- * Attribute values of the new RDN not matching any attribute value of the
- * entry are added to the entry, and an appropriate error is returned if this
- * fails.
- *
- * @param rdn
- * The new RDN of the entry to be renamed.
- * @return This modify DN request.
- * @throws UnsupportedOperationException
- * If this modify DN request does not permit the new RDN to be set.
- * @throws NullPointerException
- * If {@code rdn} was {@code null}.
- */
- ModifyDNRequest setNewRDN(RDN rdn);
-
-
-
- /**
- * Sets the new RDN of the entry to be renamed. The value of the old RDN is
- * supplied when moving the entry to a new superior without changing its RDN.
- * Attribute values of the new RDN not matching any attribute value of the
- * entry are added to the entry, and an appropriate error is returned if this
- * fails.
- *
- * @param rdn
- * The new RDN of the entry to be renamed.
- * @return This modify DN request.
- * @throws LocalizedIllegalArgumentException
- * If {@code rdn} could not be decoded using the default schema.
- * @throws UnsupportedOperationException
- * If this modify DN request does not permit the new RDN to be set.
- * @throws NullPointerException
- * If {@code rdn} was {@code null}.
- */
- ModifyDNRequest setNewRDN(String rdn);
-
-
-
- /**
- * 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.
- *
- * @param dn
- * The distinguished name of an existing entry that will become the
- * immediate superior (parent) of the entry to be renamed, may be
- * {@code null}.
- * @return This modify DN request.
- * @throws UnsupportedOperationException
- * If this modify DN request does not permit the new superior to be
- * set.
- */
- ModifyDNRequest setNewSuperior(DN dn);
-
-
-
- /**
- * 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.
- *
- * @param dn
- * The distinguished name of an existing entry that will become the
- * immediate superior (parent) of the entry to be renamed, may be
- * {@code null}.
- * @return This modify DN request.
- * @throws LocalizedIllegalArgumentException
- * If {@code dn} could not be decoded using the default schema.
- * @throws UnsupportedOperationException
- * If this modify DN request does not permit the new superior to be
- * set.
- */
- ModifyDNRequest setNewSuperior(String dn);
+ /**
+ * 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.
+ *
+ * @param dn
+ * The distinguished name of an existing entry that will become
+ * the immediate superior (parent) of the entry to be renamed,
+ * may be {@code null}.
+ * @return This modify DN request.
+ * @throws LocalizedIllegalArgumentException
+ * If {@code dn} could not be decoded using the default schema.
+ * @throws UnsupportedOperationException
+ * If this modify DN request does not permit the new superior to
+ * be set.
+ */
+ ModifyDNRequest setNewSuperior(String dn);
}
--
Gitblit v1.10.0