    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 *      https://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
    019import java.time.Instant;
    020
    021/**
    022 * Allows pooled objects to make information available about when and how they were used available to the object pool.
    023 * The object pool may, but is not required, to use this information to make more informed decisions when determining
    024 * the state of a pooled object - for instance whether or not the object has been abandoned.
    025 *
    026 * @since 2.0
    027 */
    028public interface TrackedUse {
    029
    030    /**
    031     * Gets the last time this object was used in milliseconds.
    032     *
    033     * @return the last time this object was used in milliseconds.
    034     * @deprecated Use {@link #getLastUsedInstant()} which offers the best precision.
    035     */
    036    @Deprecated
    037    long getLastUsed();
    038
    039    /**
    040     * Gets the last Instant this object was used.
    041     * <p>
    042     * Starting with Java 9, the JRE {@code SystemClock} precision is increased usually down to microseconds, or tenth
    043     * of microseconds, depending on the OS, Hardware, and JVM implementation.
    044     * </p>
    045     *
    046     * @return the last Instant this object was used.
    047     * @since 2.11.0
    048     */
    049    default Instant getLastUsedInstant() {
    050        return Instant.ofEpochMilli(getLastUsed());
    051    }
    052}