View Javadoc
1   /*
2   * Copyright 2014 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   *   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, 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  
17  package io.netty.util.internal;
18  
19  import io.netty.util.Recycler;
20  
21  /**
22   * {@link MpscLinkedQueueNode} that will automatically call {@link Recycler.Handle#recycle(Object)} when the node was
23   * unlinked.
24   */
25  public abstract class RecyclableMpscLinkedQueueNode<T> extends MpscLinkedQueueNode<T> {
26      @SuppressWarnings("rawtypes")
27      private final Recycler.Handle handle;
28  
29      protected RecyclableMpscLinkedQueueNode(Recycler.Handle<? extends RecyclableMpscLinkedQueueNode<T>> handle) {
30          if (handle == null) {
31              throw new NullPointerException("handle");
32          }
33          this.handle = handle;
34      }
35  
36      @SuppressWarnings("unchecked")
37      @Override
38      final void unlink() {
39          super.unlink();
40          handle.recycle(this);
41      }
42  }