/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * 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/opends/resource/legal-notices/OpenDS.LICENSE.  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
 *
 *
 *      Copyright 2010 Sun Microsystems, Inc.
 */

package org.opends.sdk.responses;



import org.opends.sdk.ByteString;
import org.opends.sdk.ResultCode;

import com.sun.opends.sdk.util.StaticUtils;



/**
 * An abstract Extended result which can be used as the basis for implementing
 * new Extended operations.
 *
 * @param <S>
 *          The type of Extended result.
 */
public abstract class AbstractExtendedResult<S extends ExtendedResult>
    extends AbstractResultImpl<S> implements ExtendedResult
{

  /**
   * Creates a new extended result using the provided result code.
   *
   * @param resultCode
   *          The result code.
   * @throws NullPointerException
   *           If {@code resultCode} was {@code null}.
   */
  protected AbstractExtendedResult(final ResultCode resultCode)
      throws NullPointerException
  {
    super(resultCode);
  }



  /**
   * Creates a new extended result that is an exact copy of the provided
   * result.
   *
   * @param extendedResult
   *          The extended result to be copied.
   * @throws NullPointerException
   *           If {@code extendedResult} was {@code null} .
   */
  protected AbstractExtendedResult(ExtendedResult extendedResult)
      throws NullPointerException
  {
    super(extendedResult);
  }



  /**
   * {@inheritDoc}
   */
  public abstract String getOID();



  /**
   * {@inheritDoc}
   */
  public abstract ByteString getValue();



  /**
   * {@inheritDoc}
   */
  public abstract boolean hasValue();



  /**
   * {@inheritDoc}
   */
  @Override
  public String toString()
  {
    final StringBuilder builder = new StringBuilder();
    builder.append("ExtendedResult(resultCode=");
    builder.append(getResultCode());
    builder.append(", matchedDN=");
    builder.append(getMatchedDN());
    builder.append(", diagnosticMessage=");
    builder.append(getDiagnosticMessage());
    builder.append(", referrals=");
    builder.append(getReferralURIs());
    builder.append(", responseName=");
    builder.append(getOID() == null ? "" : getOID());
    if (hasValue())
    {
      builder.append(", responseValue=");
      StaticUtils.toHexPlusAscii(getValue(), builder, 4);
    }
    builder.append(", controls=");
    builder.append(getControls());
    builder.append(")");
    return builder.toString();
  }



  /**
   * {@inheritDoc}
   */
  @Override
  @SuppressWarnings("unchecked")
  final S getThis()
  {
    return (S) this;
  }
}