Source code

    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 (primarily those clients that wrap pools to
    021 * provide pools with extended features) to provide additional information to the pool relating to object using allowing
    022 * more informed decisions and reporting to be made regarding abandoned objects.
    023 *
    024 * @param <T> The type of object provided by the pool.
    025 *
    026 * @since 2.0
    027 */
    028public interface UsageTracking<T> {
    029
    030    /**
    031     * Called every time a pooled object is used to enable the pool to better track borrowed objects.
    032     *
    033     * @param pooledObject The object that is being used.
    034     */
    035    void use(T pooledObject);
    036}