third-party/atomix/utils/src/main/java/io/atomix/utils/concurrent/ReferenceManager.java

   1 /*
   2  * Copyright 2017-present Open Networking Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * 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,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package io.atomix.utils.concurrent;
  17
  18 /**
  19  * Reference manager. Manages {@link ReferenceCounted} objects.
  20  *
  21  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  22  */
  23 public interface ReferenceManager<T> {
  24
  25   /**
  26    * Releases the given reference.
  27    * <p>
  28    * This method should be called with a {@link ReferenceCounted} object that contains no
  29    * additional references. This allows, for instance, pools to recycle dereferenced objects.
  30    *
  31    * @param reference The reference to release.
  32    */
  33   void release(T reference);
  34
  35 }