Reformat to comply with new Checkstyle rules.

Matthew Swift

25.33.2012 263d085885df024dca9250cc03c807912b0a7662

 opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/controls/Control.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
@@ -26,12 +25,8 @@
 */
package org.forgerock.opendj.ldap.controls;



import org.forgerock.opendj.ldap.ByteString;



/**
 * Controls provide a mechanism whereby the semantics and arguments of existing
 * LDAP operations may be extended. One or more controls may be attached to a
@@ -42,55 +37,48 @@
 * @see <a href="http://tools.ietf.org/html/rfc4511">RFC 4511 - Lightweight
 *      Directory Access Protocol (LDAP): The Protocol </a>
 */
public interface Control
{
public interface Control {

  /**
   * Returns the numeric OID associated with this control.
   *
   * @return The numeric OID associated with this control.
   */
  String getOID();
    /**
     * Returns the numeric OID associated with this control.
     *
     * @return The numeric OID associated with this control.
     */
    String getOID();

    /**
     * Returns the value, if any, associated with this control. Its format is
     * defined by the specification of this control.
     *
     * @return The value associated with this control, or {@code null} if there
     *         is no value.
     */
    ByteString getValue();

    /**
     * Returns {@code true} if this control has a value. In some circumstances
     * it may be useful to determine if a control has a value, without actually
     * calculating the value and incurring any performance costs.
     *
     * @return {@code true} if this control has a value, or {@code false} if
     *         there is no value.
     */
    boolean hasValue();

  /**
   * Returns the value, if any, associated with this control. Its format is
   * defined by the specification of this control.
   *
   * @return The value associated with this control, or {@code null} if there is
   *         no value.
   */
  ByteString getValue();



  /**
   * Returns {@code true} if this control has a value. In some circumstances it
   * may be useful to determine if a control has a value, without actually
   * calculating the value and incurring any performance costs.
   *
   * @return {@code true} if this control has a value, or {@code false} if there
   *         is no value.
   */
  boolean hasValue();



  /**
   * Returns {@code true} if it is unacceptable to perform the operation without
   * applying the semantics of this control.
   * <p>
   * The criticality field only has meaning in controls attached to request
   * messages (except UnbindRequest). For controls attached to response messages
   * and the UnbindRequest, the criticality field SHOULD be {@code false}, and
   * MUST be ignored by the receiving protocol peer. A value of {@code true}
   * indicates that it is unacceptable to perform the operation without applying
   * the semantics of the control.
   *
   * @return {@code true} if this control must be processed by the Directory
   *         Server, or {@code false} if it can be ignored.
   */
  boolean isCritical();
    /**
     * Returns {@code true} if it is unacceptable to perform the operation
     * without applying the semantics of this control.
     * <p>
     * The criticality field only has meaning in controls attached to request
     * messages (except UnbindRequest). For controls attached to response
     * messages and the UnbindRequest, the criticality field SHOULD be
     * {@code false}, and MUST be ignored by the receiving protocol peer. A
     * value of {@code true} indicates that it is unacceptable to perform the
     * operation without applying the semantics of the control.
     *
     * @return {@code true} if this control must be processed by the Directory
     *         Server, or {@code false} if it can be ignored.
     */
    boolean isCritical();

}