third-party/atomix/utils/src/main/java/io/atomix/utils/concurrent/ReferenceCounted.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 counting interface.
  20  * <p>
  21  * Types that implement {@code ReferenceCounted} can be counted for references and thus used to clean up resources once
  22  * a given instance of an object is no longer in use.
  23  *
  24  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  25  */
  26 public interface ReferenceCounted<T> extends AutoCloseable {
  27
  28   /**
  29    * Acquires a reference.
  30    *
  31    * @return The acquired reference.
  32    */
  33   T acquire();
  34
  35   /**
  36    * Releases a reference.
  37    *
  38    * @return Indicates whether all references to the object have been released.
  39    */
  40   boolean release();
  41
  42   /**
  43    * Returns the number of open references.
  44    *
  45    * @return The number of open references.
  46    */
  47   int references();
  48
  49   /**
  50    * Defines an exception free close implementation.
  51    */
  52   @Override
  53   void close();
  54
  55 }