ArrowBuffer.java

/*
 * 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.arrow.vector.ipc.message;

import com.google.flatbuffers.FlatBufferBuilder;
import org.apache.arrow.flatbuf.Buffer;

/** Metadata for a buffer written to a channel. */
public class ArrowBuffer implements FBSerializable {

  private long offset;
  private long size;

  /**
   * Constructs a new instance.
   *
   * @param offset The offset to the start of the buffer in the channel.
   * @param size The size of the buffer.
   */
  public ArrowBuffer(long offset, long size) {
    super();
    this.offset = offset;
    this.size = size;
  }

  public long getOffset() {
    return offset;
  }

  public long getSize() {
    return size;
  }

  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + (int) (offset ^ (offset >>> 32));
    result = prime * result + (int) (size ^ (size >>> 32));
    return result;
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    ArrowBuffer other = (ArrowBuffer) obj;
    if (offset != other.offset) {
      return false;
    }
    if (size != other.size) {
      return false;
    }
    return true;
  }

  @Override
  public int writeTo(FlatBufferBuilder builder) {
    return Buffer.createBuffer(builder, offset, size);
  }

  @Override
  public String toString() {
    return "ArrowBuffer [offset=" + offset + ", size=" + size + "]";
  }
}