View Javadoc
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.internal;
17  
18  import io.netty5.buffer.api.AllocationType;
19  import io.netty5.util.internal.UnstableApi;
20  
21  /**
22   * An {@link AllocationType} for on-heap buffer allocations that wrap an existing byte array.
23   */
24  @SuppressWarnings("AssignmentOrReturnOfFieldWithMutableType") // This is the express purpose of this class.
25  @UnstableApi
26  public final class WrappingAllocation implements AllocationType {
27      private final byte[] array;
28  
29      public WrappingAllocation(byte[] array) {
30          this.array = array;
31      }
32  
33      public byte[] getArray() {
34          return array;
35      }
36  
37      @Override
38      public boolean isDirect() {
39          return false;
40      }
41  }