View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.pool2;
18  
19  /**
20   * This interface may be implemented by an object pool to enable clients (primarily those clients that wrap pools to
21   * provide pools with extended features) to provide additional information to the pool relating to object using allowing
22   * more informed decisions and reporting to be made regarding abandoned objects.
23   *
24   * @param <T> The type of object provided by the pool.
25   *
26   * @since 2.0
27   */
28  public interface UsageTracking<T> {
29  
30      /**
31       * Called every time a pooled object is used to enable the pool to better track borrowed objects.
32       *
33       * @param pooledObject The object that is being used.
34       */
35      void use(T pooledObject);
36  }