/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.client.coprocessor;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;
import org.apache.hadoop.hbase.io.HbaseObjectWritable;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.hadoop.hbase.util.Classes;
import org.apache.hadoop.io.Writable;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.io.Serializable;

/**
 * Represents the return value from a
 * {@link org.apache.hadoop.hbase.client.coprocessor.Exec} invocation.
 * This simply wraps the value for easier
 * {@link org.apache.hadoop.hbase.io.HbaseObjectWritable}
 * serialization.
 *
 * <p>
 * This class is used internally by the HBase client code to properly serialize
 * responses from {@link org.apache.hadoop.hbase.ipc.CoprocessorProtocol}
 * method invocations.  It should not be used directly by clients.
 * </p>
 *
 * @see Exec
 * @see org.apache.hadoop.hbase.client.HTable#coprocessorExec(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call)
 * @see org.apache.hadoop.hbase.client.HTable#coprocessorExec(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)
 * @deprecated since 0.96.0.  See {@link org.apache.hadoop.hbase.client.HTable#coprocessorService(byte[])}
 * or related methods instead.
 */
@Deprecated
@InterfaceAudience.Public
@InterfaceStability.Evolving
public class ExecResult implements Writable {
  private byte[] regionName;
  private Object value;

  public ExecResult() {
  }

  public ExecResult(byte[] region, Object value) {
    this.regionName = region;
    this.value = value;
  }

  public byte[] getRegionName() {
    return regionName;
  }

  public Object getValue() {
    return value;
  }

  @Override
  public void write(DataOutput out) throws IOException {
    Bytes.writeByteArray(out, regionName);
    HbaseObjectWritable.writeObject(out, value,
        value != null ? value.getClass() : Writable.class, null);
  }

  @Override
  public void readFields(DataInput in) throws IOException {
    regionName = Bytes.readByteArray(in);
    value = HbaseObjectWritable.readObject(in, null);
  }
}