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;
17  
18  import io.netty5.util.Resource;
19  
20  /**
21   * An interface used by {@link Resource} instances to implement their resource disposal mechanics.
22   * The {@link #drop(Object)} method will be called by the resource when they are closed.
23   *
24   * @param <T> The type of resource that can be dropped.
25   */
26  public interface Drop<T> {
27      /**
28       * Dispose of the resources in the given {@link Resource} instance.
29       *
30       * @param obj The {@link Resource} instance being dropped.
31       */
32      void drop(T obj);
33  
34      /**
35       * Branch the responsibility of dropping a resource.
36       * This drop instance will remain associated with its current resource, while the returned drop instance
37       * must be {@linkplain #attach(Object) attached} to its new resource.
38       *
39       * @return A drop instance, similar to this one, but for the purpose of being associated with a different but
40       * related resource.
41       */
42      Drop<T> fork();
43  
44      /**
45       * Called when the resource changes owner.
46       *
47       * @param obj The new {@link Resource} instance with the new owner.
48       */
49      void attach(T obj);
50  }