001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.pool2;
018
019/**
020 * This interface may be implemented by an object pool to enable clients
021 * (primarily those clients that wrap pools to provide pools with extended
022 * features) to provide additional information to the pool relating to object
023 * using allowing more informed decisions and reporting to be made regarding
024 * abandoned objects.
025 *
026 * @param <T>   The type of object provided by the pool.
027 *
028 * @since 2.0
029 */
030public interface UsageTracking<T> {
031
032    /**
033     * This method is called every time a pooled object is used to enable the pool to
034     * better track borrowed objects.
035     *
036     * @param pooledObject  The object that is being used
037     */
038    void use(T pooledObject);
039}