com.diffplug.common.rx

Class OrderedLock

java.lang.Object

com.diffplug.common.rx.OrderedLock

public class OrderedLock
extends Object

All code which takes locks using this code is guaranteed to do so in the same order, guaranteeing there won't be a deadlock. `OrderedLock` instances can be reused as many times as you'd like, and they're expensive to create and cheap to keep around, so reuse is highly recommended. Thanks to Brian Goetz and Tim Peierls for their great demo for how to handle the case that they have the same hashcode: https://books.google.com/books?id=mzgFCAAAQBAJ&pg=PA208&dq=System.identityHashCode&hl=en&sa=X&ved=0ahUKEwjUvrLcjufMAhWG4IMKHS4NDVwQ6AEIKzAC#v=onepage&q=System.identityHashCode&f=false

Method Summary

Modifier and Type	Method and Description
static OrderedLock	on(Collection<?> locks) Creates an OrderedLock for the given collection of locks.
static OrderedLock	on(Object... locks) Creates an OrderedLock for the given array of locks.
<T> T	takeAndGet(Supplier<T> toGet) Takes the locks in a globally consistent order, then calls the given supplier and returns its value.
void	takeAndRun(Runnable toRun) Takes the locks in a globally consistent order, then runs the given Runnable.
Runnable	wrap(Runnable toWrap) Returns a Runnable which will get and release the appropriate locks before executing its argument.
<T> Supplier<T>	wrap(Supplier<T> toWrap) Returns a Supplier which will get and release the appropriate locks before executing its argument.

Methods inherited from class java.lang.Object

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

Method Detail

on

public static OrderedLock on(Collection<?> locks)

Creates an OrderedLock for the given collection of locks.

on

public static OrderedLock on(Object... locks)

Creates an OrderedLock for the given array of locks.

takeAndGet

public <T> T takeAndGet(Supplier<T> toGet)

Takes the locks in a globally consistent order, then calls the given supplier and returns its value.

takeAndRun

public void takeAndRun(Runnable toRun)

Takes the locks in a globally consistent order, then runs the given Runnable.

wrap

public Runnable wrap(Runnable toWrap)

Returns a Runnable which will get and release the appropriate locks before executing its argument.

wrap

public <T> Supplier<T> wrap(Supplier<T> toWrap)

Returns a Supplier which will get and release the appropriate locks before executing its argument.