blob: b10f7c3267662c620f41dd12144d87c94bda0f47 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc;
/**
* <p>Represents a live reference to a {@link SharedResource}. Only provides the ability to release the reference.</p>
*
* <p>Implements {@link AutoCloseable} so that it can be used in try-with-resources statements. Example</p>
* <pre>
* void doSomethingWithRequest(final Request request) {
* try (final ResourceReference ref = request.refer()) {
* // Do something with request
* }
* // ref.close() will be called automatically on exit from the try block, releasing the reference on 'request'.
* }
* </pre>
*
* @author bakksjo
*/
public interface ResourceReference extends AutoCloseable {
/**
* <p>Decrements the reference count of the referenced resource.
* You call this method once you are done using an object
* that you have previously {@link SharedResource#refer() referred}.</p>
*
* <p>Note that this method is NOT idempotent; you must call it exactly once.</p>
*
* @see SharedResource#refer()
*/
@Override
void close();
}
|
