• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc.  All rights reserved.
3 // https://developers.google.com/protocol-buffers/
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 //     * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //     * Redistributions in binary form must reproduce the above
12 // copyright notice, this list of conditions and the following disclaimer
13 // in the documentation and/or other materials provided with the
14 // distribution.
15 //     * Neither the name of Google Inc. nor the names of its
16 // contributors may be used to endorse or promote products derived from
17 // this software without specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 package com.google.protobuf;
32 
33 import java.nio.ByteBuffer;
34 
35 /**
36  * An object responsible for allocation of buffers. This is an extension point to enable buffer
37  * pooling within an application.
38  */
39 @ExperimentalApi
40 abstract class BufferAllocator {
41   private static final BufferAllocator UNPOOLED =
42       new BufferAllocator() {
43         @Override
44         public AllocatedBuffer allocateHeapBuffer(int capacity) {
45           return AllocatedBuffer.wrap(new byte[capacity]);
46         }
47 
48         @Override
49         public AllocatedBuffer allocateDirectBuffer(int capacity) {
50           return AllocatedBuffer.wrap(ByteBuffer.allocateDirect(capacity));
51         }
52       };
53 
54   /** Returns an unpooled buffer allocator, which will create a new buffer for each request. */
unpooled()55   public static BufferAllocator unpooled() {
56     return UNPOOLED;
57   }
58 
59   /** Allocates a buffer with the given capacity that is backed by an array on the heap. */
allocateHeapBuffer(int capacity)60   public abstract AllocatedBuffer allocateHeapBuffer(int capacity);
61 
62   /** Allocates a direct (i.e. non-heap) buffer with the given capacity. */
allocateDirectBuffer(int capacity)63   public abstract AllocatedBuffer allocateDirectBuffer(int capacity);
64 }
65