uk.kludje

Class Res<R>

java.lang.Object

uk.kludje.Res<R>

Type Parameters:

R - the underlying resource type

All Implemented Interfaces:

java.lang.AutoCloseable, CloseableResource

public class Res<R>
extends java.lang.Object
implements CloseableResource

Adapts any type to AutoCloseable so that its instances can be closed by try blocks. Usage:

   try (Res<SomeResource> someResource = Res.res(SomeResource::release, new SomeResource)) {
     someResource.unwrap().foo();
   }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Res.CloseFunction<R> Functional interface for closing a resource.

Method Summary

Modifier and Type	Method and Description
void	close() Throws any exception thrown by Res.CloseFunction.close(Object) including checked exceptions.
<T extends java.lang.Throwable> Res<R>	expected() Fluent method for allowing an instance to declare it throws any Throwable.
static <R> Res<R>	res(Res.CloseFunction<R> closeFunction, R resource) Creates a new Res instance.
R	unwrap()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

unwrap

public R unwrap()

Returns:

the resource instance

close

public void close()

Throws any exception thrown by Res.CloseFunction.close(Object) including checked exceptions. If the Res.CloseFunction throws a checked exception not declared by any other call use expected() to tell the compiler to expect it.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface CloseableResource

res

public static <R> Res<R> res(Res.CloseFunction<R> closeFunction,
                             R resource)

Creates a new Res instance.

Type Parameters:

R - the resource type

Parameters:

closeFunction - the function for releasing the resource

resource - the resource instance

Returns:

expected

public <T extends java.lang.Throwable> Res<R> expected()
                                                throws T extends java.lang.Throwable

Description copied from interface: CloseableResource

Fluent method for allowing an instance to declare it throws any Throwable.

Specified by:

expected in interface CloseableResource

Type Parameters:

T - the type of exception to expect

Returns:

this

Throws:

T extends java.lang.Throwable

See Also:

Exceptions.expected()