appc-common/src/main/java/org/onap/appc/pool/Allocator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24
  25
  26 package org.onap.appc.pool;
  27
  28 import java.io.Closeable;
  29
  30 /**
  31  * This interface is used to supply an object that will be called by the pool manager whenever a new widget must be
  32  * allocated.
  33  * @param <T>
  34  *            The generic type that we are caching.
  35  */
  36
  37 public interface Allocator<T extends Closeable> {
  38
  39     /**
  40      * Allocate an object of type <T> and return it to the pool
  41      *
  42      * @param pool
  43      *            The pool that the object is to be allocated to
  44      * @return An object of type T
  45      */
  46     T allocate(Pool<T> pool);
  47 }