third-party/atomix/storage/src/main/java/io/atomix/storage/buffer/BufferAllocator.java

   1 /*
   2  * Copyright 2015-present Open Networking Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package io.atomix.storage.buffer;
  17
  18 /**
  19  * Buffer allocator.
  20  *
  21  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  22  */
  23 public interface BufferAllocator {
  24
  25   /**
  26    * Allocates a dynamic capacity buffer.
  27    *
  28    * @return The allocated buffer.
  29    */
  30   Buffer allocate();
  31
  32   /**
  33    * Allocates a dynamic capacity buffer with the given initial capacity.
  34    *
  35    * @param initialCapacity The initial buffer capacity.
  36    * @return The allocated buffer.
  37    */
  38   Buffer allocate(int initialCapacity);
  39
  40   /**
  41    * Allocates a new buffer.
  42    *
  43    * @param initialCapacity The initial buffer capacity.
  44    * @param maxCapacity     The maximum buffer capacity.
  45    * @return The allocated buffer.
  46    */
  47   Buffer allocate(int initialCapacity, int maxCapacity);
  48
  49 }