1 /*
2 * Copyright 2021 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://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, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty5.buffer.api;
17
18 /**
19 * An object used by {@linkplain BufferAllocator buffer allocators} to communicate desirable properties of an
20 * allocation to a {@linkplain MemoryManager memory manager}, such as whether an allocation should be off-heap.
21 * <p>
22 * Standard implementations of this interface can be found in {@link StandardAllocationTypes}.
23 */
24 public interface AllocationType {
25 /**
26 * @return {@code true} if this allocation type produces off-heap, or direct buffers.
27 * Otherwise {@code false}, if the buffers are on-heap.
28 */
29 boolean isDirect();
30 }