com.atakmap.android.util

Class ReservationService<T>

java.lang.Object

com.atakmap.android.util.ReservationService<T>

Type Parameters:

T - The type of object being reserved. Compared using equals.

Direct Known Subclasses:

FileCache

public class ReservationService<T>
extends java.lang.Object

Provides simple thread-safe reservation of objects. Reservation requests are blocked until the requested object is available for reservation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReservationService.Reservation<T> A token used as proof of a reservation.

Constructor Summary

Constructors

Constructor and Description
ReservationService()

Method Summary

Modifier and Type	Method and Description
protected ReservationService.Reservation<T>	createReservation(T item) Creates a reservation containing the supplied item.
boolean	isReserved(T item) Checks whether the supplied item is already reserved.
ReservationService.Reservation<T>	reserve(T item) Attempts to reserve the supplied item.
ReservationService.Reservation<T>	tryReserve(T item) Attempts to reserve the supplied item.
boolean	tryWithReservation(T item, java.lang.Runnable r) Runs the supplied Runnable after trying to establishing a reservation for the supplied item.
void	unreserve(ReservationService.Reservation<T> reservation) Releases the supplied Reservation, making its contained item available for waiting reservations.
boolean	withReservation(T item, java.lang.Runnable r) Runs the supplied Runnable after establishing a reservation for the supplied item.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReservationService

public ReservationService()

Method Detail

isReserved

public boolean isReserved(T item)

Checks whether the supplied item is already reserved.

Parameters:

item - The item to check for reservation.

Returns:

True if the item is reserved; false if not.

reserve

public ReservationService.Reservation<T> reserve(T item)

Attempts to reserve the supplied item. Blocks the calling thread until the item is reserved.

Parameters:

item - The item to be reserved.

Returns:

A Reservation if the reservation was completed; null if the thread was interrupted.

tryReserve

public ReservationService.Reservation<T> tryReserve(T item)

Attempts to reserve the supplied item. Balks if the item is already reserved.

Parameters:

item - The item to be reserved.

Returns:

A Reservation if the reservation was completed; null if the thread was interrupted.

tryWithReservation

public boolean tryWithReservation(T item,
                                  java.lang.Runnable r)

Runs the supplied Runnable after trying to establishing a reservation for the supplied item. Balks if the item is already reserved. Releases the reservation after the Runnable has executed.

Parameters:

item - The item to be reserved while the Runnable executes.

r - The Runnable to be executed while the item is reserved.

Returns:

True if the reservation was completed; false if the item was already reserved.

unreserve

public void unreserve(ReservationService.Reservation<T> reservation)

Releases the supplied Reservation, making its contained item available for waiting reservations.

Parameters:

reservation - The Reservation to be released.

withReservation

public boolean withReservation(T item,
                               java.lang.Runnable r)

Runs the supplied Runnable after establishing a reservation for the supplied item. Releases the reservation after the Runnable has executed.

Parameters:

item - The item to be reserved while the Runnable executes.

r - The Runnable to be executed while the item is reserved.

Returns:

True if the reservation was completed; false if the thread was interrupted.

createReservation

protected ReservationService.Reservation<T> createReservation(T item)

Creates a reservation containing the supplied item. Derived classes may override this method to perform additional work when a Reservation is created.

Parameters:

item - The item being reserved.

Returns:

The Reservation token for the item.