third-party/atomix/utils/src/main/java/io/atomix/utils/memory/MemoryAllocator.java

   1 /*
   2  * Copyright 2017-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.utils.memory;
  17
  18 /**
  19  * Memory allocator.
  20  * <p>
  21  * Memory allocators handle allocation of memory for {@link Memory} objects.
  22  *
  23  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  24  */
  25 public interface MemoryAllocator<T extends Memory> {
  26
  27   /**
  28    * Allocates memory.
  29    *
  30    * @param size The count of the memory to allocate.
  31    * @return The allocated memory.
  32    */
  33   T allocate(int size);
  34
  35   /**
  36    * Reallocates the given memory.
  37    * <p>
  38    * When the memory is reallocated, the memory address for the given {@link Memory} instance may change. The returned
  39    * {@link Memory} instance will contain the updated address and count.
  40    *
  41    * @param memory The memory to reallocate.
  42    * @param size   The count to which to reallocate the given memory.
  43    * @return The reallocated memory.
  44    */
  45   T reallocate(T memory, int size);
  46
  47 }