Modifier and Type	Class and Description
private static class	AbstractWatchKey.Event<T> WatchEvent implementation
private static enum	AbstractWatchKey.State Possible key states

Field Summary

Modifier and Type	Field and Description
private static final int	DEFAULT_MAX_EVENT_LIST_SIZE
private final Path	dir
private List<WatchEvent<?>>	events
private Map<Object, WatchEvent<?>>	lastModifyEvents
pack-priv static final int	MAX_EVENT_LIST_SIZE Maximum size of event list before dropping events and signalling OVERFLOW
pack-priv static final AbstractWatchKey.Event<Object>	OVERFLOW_EVENT Special event to signal overflow
private AbstractWatchKey.State	state
private final AbstractWatchService	watcher

Access	Constructor and Description
protected	AbstractWatchKey(Path dir, AbstractWatchService watcher)

Method Summary

Modifier and Type	Method and Description
public final List<WatchEvent<?>>	pollEvents() Implements java.nio.file.WatchKey.pollEvents. Retrieves and removes all pending events for this watch key, returning a `List` of the events that were retrieved.
public final boolean	reset() Implements java.nio.file.WatchKey.reset. Resets this watch key.
pack-priv final void	signal() Enqueues this key to the watch service
pack-priv final void	signalEvent(WatchEvent.Kind<?> kind, Object context) Adds the event to this key and signals it.
public Path	watchable() Implements java.nio.file.WatchKey.watchable. Return the original watchable (Path)
pack-priv final AbstractWatchService	watcher()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_MAX_EVENT_LIST_SIZE	back to summary
private static final int DEFAULT_MAX_EVENT_LIST_SIZE

dir	back to summary
private final Path dir

events	back to summary
private List<WatchEvent<?>> events

lastModifyEvents	back to summary
private Map<Object, WatchEvent<?>> lastModifyEvents

MAX_EVENT_LIST_SIZE	back to summary
pack-priv static final int MAX_EVENT_LIST_SIZE Maximum size of event list before dropping events and signalling OVERFLOW

OVERFLOW_EVENT	back to summary
pack-priv static final AbstractWatchKey.Event<Object> OVERFLOW_EVENT Special event to signal overflow

state	back to summary
private AbstractWatchKey.State state

watcher	back to summary
private final AbstractWatchService watcher

AbstractWatchKey	back to summary
protected AbstractWatchKey(Path dir, AbstractWatchService watcher)

Method Detail

pollEvents back to summary

pollEvents	back to summary
public final List<WatchEvent<?>> pollEvents() Implements java.nio.file.WatchKey.pollEvents. Doc from java.nio.file.WatchKey.pollEvents. Retrieves and removes all pending events for this watch key, returning a `List` of the events that were retrieved. Note that this method does not wait if there are no events pending. Annotations @Override

public final List<WatchEvent<?>> pollEvents()

Implements java.nio.file.WatchKey.pollEvents.

Doc from java.nio.file.WatchKey.pollEvents.

Retrieves and removes all pending events for this watch key, returning a List of the events that were retrieved.

Note that this method does not wait if there are no events pending.

Annotations

@Override

reset	back to summary
public final boolean reset() Implements java.nio.file.WatchKey.reset. Doc from java.nio.file.WatchKey.reset. Resets this watch key. If this watch key has been cancelled or this watch key is already in the ready state then invoking this method has no effect. Otherwise if there are pending events for the object then this watch key is immediately re-queued to the watch service. If there are no pending events then the watch key is put into the ready state and will remain in that state until an event is detected or the watch key is cancelled. Annotations @Override

reset

back to summary

public final boolean reset()

Implements java.nio.file.WatchKey.reset.

Doc from java.nio.file.WatchKey.reset.

Resets this watch key.

If this watch key has been cancelled or this watch key is already in the ready state then invoking this method has no effect. Otherwise if there are pending events for the object then this watch key is immediately re-queued to the watch service. If there are no pending events then the watch key is put into the ready state and will remain in that state until an event is detected or the watch key is cancelled.

Annotations

@Override

signal	back to summary
pack-priv final void signal() Enqueues this key to the watch service

signalEvent	back to summary
pack-priv final void signalEvent(WatchEvent.Kind<?> kind, Object context) Adds the event to this key and signals it. Annotations @SuppressWarnings:unchecked

signalEvent

back to summary

pack-priv final void signalEvent(WatchEvent.Kind<?> kind, Object context)

Adds the event to this key and signals it.

Annotations

@SuppressWarnings:unchecked

watchable	back to summary
public Path watchable() Implements java.nio.file.WatchKey.watchable. Return the original watchable (Path) Annotations @Override

watchable

back to summary

public Path watchable()

Implements java.nio.file.WatchKey.watchable.

Return the original watchable (Path)

Annotations

@Override

watcher	back to summary
pack-priv final AbstractWatchService watcher()

sun.nio.fs back to summary

private Class AbstractWatchKey.Event<T>

Class Inheritance

extends Object
implements WatchEvent<T>

java.lang.Object
sun.nio.fs.AbstractWatchKey.Event

All Implemented Interfaces

java.nio.file.WatchEvent

WatchEvent implementation

Field Summary

Modifier and Type	Field and Description
private final T	context
private int	count
private final WatchEvent.Kind<T>	kind

Constructor Summary

Access	Constructor and Description
pack-priv	Event(WatchEvent.Kind<T> type, T context)

Method Summary

Modifier and Type	Method and Description
public T	context() Implements java.nio.file.WatchEvent.context. Returns the context for the event.
public int	count() Implements java.nio.file.WatchEvent.count. Returns the event count.
pack-priv void	increment()
public WatchEvent.Kind<T>	kind() Implements java.nio.file.WatchEvent.kind. Returns the event kind.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

context	back to summary
private final T context

count	back to summary
private int count

kind	back to summary
private final WatchEvent.Kind<T> kind

Constructor Detail

Event	back to summary
pack-priv Event(WatchEvent.Kind<T> type, T context)

Method Detail

context back to summary

context	back to summary
public T context() Implements java.nio.file.WatchEvent.context. Doc from java.nio.file.WatchEvent.context. Returns the context for the event. In the case of `ENTRY_CREATE`, `ENTRY_DELETE`, and `ENTRY_MODIFY` events the context is a `Path` that is the `relative` path between the directory registered with the watch service, and the entry that is created, deleted, or modified. Annotations @Override

public T context()

Implements java.nio.file.WatchEvent.context.

Doc from java.nio.file.WatchEvent.context.

Returns the context for the event.

In the case of ENTRY_CREATE, ENTRY_DELETE, and ENTRY_MODIFY events the context is a Path that is the relative path between the directory registered with the watch service, and the entry that is created, deleted, or modified.

Annotations

@Override

count back to summary

count	back to summary
public int count() Implements java.nio.file.WatchEvent.count. Doc from java.nio.file.WatchEvent.count. Returns the event count. If the event count is greater than `1` then this is a repeated event. Annotations @Override

public int count()

Implements java.nio.file.WatchEvent.count.

Doc from java.nio.file.WatchEvent.count.

Returns the event count. If the event count is greater than 1 then this is a repeated event.

Annotations

@Override

increment	back to summary
pack-priv void increment()

kind	back to summary
public WatchEvent.Kind<T> kind() Implements java.nio.file.WatchEvent.kind. Doc from java.nio.file.WatchEvent.kind. Returns the event kind. Annotations @Override

kind

back to summary

public WatchEvent.Kind<T> kind()

Implements java.nio.file.WatchEvent.kind.

Doc from java.nio.file.WatchEvent.kind.

Returns the event kind.

Annotations

@Override

sun.nio.fs back to summary

private final Enum AbstractWatchKey.State

Class Inheritance

extends Enum<AbstractWatchKey.State>

java.lang.Object
java.lang.Enum
sun.nio.fs.AbstractWatchKey.State

Possible key states

Field Summary

Modifier and Type	Field and Description
public static final AbstractWatchKey.State	READY
public static final AbstractWatchKey.State	SIGNALLED

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static AbstractWatchKey.State	valueOf(String name)
public static AbstractWatchKey.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

READY	back to summary
public static final AbstractWatchKey.State READY

SIGNALLED	back to summary
public static final AbstractWatchKey.State SIGNALLED

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static AbstractWatchKey.State valueOf(String name)

values	back to summary
public static AbstractWatchKey.State[] values()

pack-priv abstract Class AbstractWatchKey

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AbstractWatchKey.Event<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum AbstractWatchKey.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail