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 import java.time.Instant;
20
21 /**
22 * Allows pooled objects to make information available about when and how they were used available to the object pool.
23 * The object pool may, but is not required, to use this information to make more informed decisions when determining
24 * the state of a pooled object - for instance whether or not the object has been abandoned.
25 *
26 * @since 2.0
27 */
28 public interface TrackedUse {
29
30 /**
31 * Gets the last time this object was used in milliseconds.
32 *
33 * @return the last time this object was used in milliseconds.
34 * @deprecated Use {@link #getLastUsedInstant()} which offers the best precision.
35 */
36 @Deprecated
37 long getLastUsed();
38
39 /**
40 * Gets the last Instant this object was used.
41 * <p>
42 * Starting with Java 9, the JRE {@code SystemClock} precision is increased usually down to microseconds, or tenth
43 * of microseconds, depending on the OS, Hardware, and JVM implementation.
44 * </p>
45 *
46 * @return the last Instant this object was used.
47 * @since 2.11.0
48 */
49 default Instant getLastUsedInstant() {
50 return Instant.ofEpochMilli(getLastUsed());
51 }
52 }