AllocatedBuffer.java

Go to the documentation of this file.

// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
package com.google.protobuf;
 
import static com.google.protobuf.Internal.checkNotNull;
 
import java.nio.ByteBuffer;
 
@ExperimentalApi
abstract class AllocatedBuffer {
  public abstract boolean hasNioBuffer();
 
  public abstract boolean hasArray();
 
  public abstract ByteBuffer nioBuffer();
 
  public abstract byte[] array();
 
  public abstract int arrayOffset();
 
  public abstract int position();
 
  public abstract AllocatedBuffer position(int position);
 
  public abstract int limit();
 
  public abstract int remaining();
 
  public static AllocatedBuffer wrap(byte[] bytes) {
    return wrapNoCheck(bytes, 0, bytes.length);
  }
 
  public static AllocatedBuffer wrap(final byte[] bytes, final int offset, final int length) {
    if (offset < 0 || length < 0 || (offset + length) > bytes.length) {
      throw new IndexOutOfBoundsException(
          String.format("bytes.length=%d, offset=%d, length=%d", bytes.length, offset, length));
    }
 
    return wrapNoCheck(bytes, offset, length);
  }
 
  public static AllocatedBuffer wrap(final ByteBuffer buffer) {
    checkNotNull(buffer, "buffer");
 
    return new AllocatedBuffer() {
 
      @Override
      public boolean hasNioBuffer() {
        return true;
      }
 
      @Override
      public ByteBuffer nioBuffer() {
        return buffer;
      }
 
      @Override
      public boolean hasArray() {
        return buffer.hasArray();
      }
 
      @Override
      public byte[] array() {
        return buffer.array();
      }
 
      @Override
      public int arrayOffset() {
        return buffer.arrayOffset();
      }
 
      @Override
      public int position() {
        return buffer.position();
      }
 
      @Override
      public AllocatedBuffer position(int position) {
        buffer.position(position);
        return this;
      }
 
      @Override
      public int limit() {
        return buffer.limit();
      }
 
      @Override
      public int remaining() {
        return buffer.remaining();
      }
    };
  }
 
  private static AllocatedBuffer wrapNoCheck(
      final byte[] bytes, final int offset, final int length) {
    return new AllocatedBuffer() {
      // Relative to offset.
      private int position;
 
      @Override
      public boolean hasNioBuffer() {
        return false;
      }
 
      @Override
      public ByteBuffer nioBuffer() {
        throw new UnsupportedOperationException();
      }
 
      @Override
      public boolean hasArray() {
        return true;
      }
 
      @Override
      public byte[] array() {
        return bytes;
      }
 
      @Override
      public int arrayOffset() {
        return offset;
      }
 
      @Override
      public int position() {
        return position;
      }
 
      @Override
      public AllocatedBuffer position(int position) {
        if (position < 0 || position > length) {
          throw new IllegalArgumentException("Invalid position: " + position);
        }
        this.position = position;
        return this;
      }
 
      @Override
      public int limit() {
        // Relative to offset.
        return length;
      }
 
      @Override
      public int remaining() {
        return length - position;
      }
    };
  }
}