Class AbstractWatchService.Key

java.lang.Object

com.google.common.jimfs.AbstractWatchService.Key

All Implemented Interfaces:

WatchKey

Enclosing class:

AbstractWatchService

static final class AbstractWatchService.Key
extends Object
implements WatchKey

Implementation of WatchKey for an AbstractWatchService.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	AbstractWatchService.Key.State

Field Summary

Fields

Modifier and Type	Field	Description
private final BlockingQueue<WatchEvent<?>>	events
(package private) static final int	MAX_QUEUE_SIZE
private final AtomicInteger	overflow
private final AtomicReference<AbstractWatchService.Key.State>	state
private final com.google.common.collect.ImmutableSet<WatchEvent.Kind<?>>	subscribedTypes
private final AtomicBoolean	valid
private final Watchable	watchable
private final AbstractWatchService	watcher

Constructor Summary

Constructors

Constructor	Description
Key(AbstractWatchService watcher, @Nullable Watchable watchable, Iterable<? extends WatchEvent.Kind<?>> subscribedTypes)

Method Summary

Modifier and Type	Method	Description
void	cancel()
boolean	isValid()
private static WatchEvent<Object>	overflowEvent(int count)
List<WatchEvent<?>>	pollEvents()
void	post(WatchEvent<?> event)	Posts the given event to this key.
boolean	reset()
void	signal()	Sets the state to SIGNALLED and enqueues this key with the watcher if it was previously in the READY state.
(package private) AbstractWatchService.Key.State	state()	Gets the current state of this key, State.READY or SIGNALLED.
boolean	subscribesTo(WatchEvent.Kind<?> eventType)	Gets whether or not this key is subscribed to the given type of event.
Watchable	watchable()

Methods inherited from class Object

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

Field Details

MAX_QUEUE_SIZE

static final int MAX_QUEUE_SIZE

See Also:

• Constant Field Values

watcher

private final AbstractWatchService watcher

watchable

private final Watchable watchable

subscribedTypes

private final com.google.common.collect.ImmutableSet<WatchEvent.Kind<?>> subscribedTypes

state

private final AtomicReference<AbstractWatchService.Key.State> state

valid

private final AtomicBoolean valid

overflow

private final AtomicInteger overflow

events

private final BlockingQueue<WatchEvent<?>> events

Constructor Details

Key

public Key(AbstractWatchService watcher,
 @Nullable Watchable watchable,
 Iterable<? extends WatchEvent.Kind<?>> subscribedTypes)

Method Details

overflowEvent

private static WatchEvent<Object> overflowEvent(int count)

state

AbstractWatchService.Key.State state()

Gets the current state of this key, State.READY or SIGNALLED.

subscribesTo

public boolean subscribesTo(WatchEvent.Kind<?> eventType)

Gets whether or not this key is subscribed to the given type of event.

post

public void post(WatchEvent<?> event)

Posts the given event to this key. After posting one or more events, signal() must be called to cause the key to be enqueued with the watch service.

signal

public void signal()

Sets the state to SIGNALLED and enqueues this key with the watcher if it was previously in the READY state.

isValid

public boolean isValid()

Specified by:

isValid in interface WatchKey

pollEvents

public List<WatchEvent<?>> pollEvents()

Specified by:

pollEvents in interface WatchKey

reset

@CanIgnoreReturnValue
public boolean reset()

Specified by:

reset in interface WatchKey

cancel

public void cancel()

Specified by:

cancel in interface WatchKey

watchable

public Watchable watchable()

Specified by:

watchable in interface WatchKey