Schedule (RVPF-Core API Documentation)

Object
- AbstractCollection<E>
- - AbstractSet<E>
  - - Schedule<E>

Type Parameters:

E - The event implementation.

All Implemented Interfaces:

Iterable<E>, Collection<E>, Iterator<E>, Set<E>
```
public class Schedule<E extends Schedule.Event>
extends AbstractSet<E>
implements Iterator<E>
```
Schedule.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Schedule.Event
Event.

static class Schedule.PointEvent
Point event.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Schedule.Event` Event.
`static class`	`Schedule.PointEvent` Point event.

Constructor Summary

Constructors
Constructor and Description

Schedule(boolean future)
Constructs an instance.

Constructors
Constructor and Description
`Schedule(boolean future)` Constructs an instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E event)`
`void`	`advance()` Advances to the next event.
`void`	`cancel(E event)` Cancels an event.
`protected void`	`cancelWait()` Cancels wait.
`void`	`clear()`
`boolean`	`contains(Object object)`
`boolean`	`containsAll(Collection<?> collection)`
`boolean`	`equals(Object other)`
`long`	`getDelay()` Gets the delay before the first event is due.
`protected NavigableSet<E>`	`getEvents()` Gets the events.
`protected Object`	`getMutex()` Gets the mutex.
`int`	`hashCode()`
`boolean`	`hasNext()`
`boolean`	`isEmpty()`
`Iterator<E>`	`iterator()`
`E`	`next()`
`protected Optional<E>`	`next(boolean wait)` Returns the next event.
`Optional<E>`	`peek()` Peeks at the first event.
`void`	`remove()`
`boolean`	`remove(Object object)`
`boolean`	`removeAll(Collection<?> collection)`
`boolean`	`retainAll(Collection<?> collection)`
`protected void`	`rollback()` Rolls back the latest call to `next(boolean)`.
`int`	`size()`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] array)`
`String`	`toString()`

Methods inherited from class AbstractCollection
addAll

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterator
forEachRemaining

Methods inherited from interface Set
addAll, spliterator

Methods inherited from interface Collection
parallelStream, removeIf, stream

Methods inherited from interface Iterable
forEach

- Constructor Detail
  - Schedule
```
public Schedule(boolean future)
```
    Constructs an instance.
    
    Parameters:
    
    future - True to schedule only in the future.
- Method Detail
  - add
```
public final boolean add(E event)
```
    Specified by:
    
    add in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    add in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    add in class AbstractCollection<E extends Schedule.Event>
  - advance
```
public final void advance()
```
    Advances to the next event.
  - cancel
```
public final void cancel(@Nonnull
                         E event)
```
    Cancels an event.
    
    Parameters:
    
    event - The event.
  - clear
```
public final void clear()
```
    Specified by:
    
    clear in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    clear in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    clear in class AbstractCollection<E extends Schedule.Event>
  - contains
```
public final boolean contains(Object object)
```
    Specified by:
    
    contains in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    contains in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    contains in class AbstractCollection<E extends Schedule.Event>
  - containsAll
```
public final boolean containsAll(Collection<?> collection)
```
    Specified by:
    
    containsAll in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    containsAll in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    containsAll in class AbstractCollection<E extends Schedule.Event>
  - equals
```
public final boolean equals(Object other)
```
    Specified by:
    
    equals in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    equals in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    equals in class AbstractSet<E extends Schedule.Event>
  - getDelay
```
@CheckReturnValue
public final long getDelay()
```
    Gets the delay before the first event is due.
    
    Returns:
    
    A number of milliseconds (negative if overdue).
    
    Throws:
    
    Require.FailureException - When empty.
  - hasNext
```
public final boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<E extends Schedule.Event>
  - hashCode
```
public final int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    hashCode in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    hashCode in class AbstractSet<E extends Schedule.Event>
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    isEmpty in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    isEmpty in class AbstractCollection<E extends Schedule.Event>
  - iterator
```
public final Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E extends Schedule.Event>
    
    Specified by:
    
    iterator in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    iterator in interface Set<E extends Schedule.Event>
    
    Specified by:
    
    iterator in class AbstractCollection<E extends Schedule.Event>
  - next
```
public final E next()
```
    Specified by:
    
    next in interface Iterator<E extends Schedule.Event>
  - peek
```
@Nonnull
 @CheckReturnValue
public final Optional<E> peek()
```
    Peeks at the first event.
    
    Returns:
    
    The first event (empty if none).
  - remove
```
public final void remove()
```
    Specified by:
    
    remove in interface Iterator<E extends Schedule.Event>
  - remove
```
public final boolean remove(Object object)
```
    Specified by:
    
    remove in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    remove in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    remove in class AbstractCollection<E extends Schedule.Event>
  - removeAll
```
public final boolean removeAll(Collection<?> collection)
```
    Specified by:
    
    removeAll in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    removeAll in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    removeAll in class AbstractSet<E extends Schedule.Event>
  - retainAll
```
public final boolean retainAll(Collection<?> collection)
```
    Specified by:
    
    retainAll in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    retainAll in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    retainAll in class AbstractCollection<E extends Schedule.Event>
  - size
```
public final int size()
```
    Specified by:
    
    size in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    size in interface Set<E extends Schedule.Event>
    
    Specified by:
    
    size in class AbstractCollection<E extends Schedule.Event>
  - toArray
```
public final Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    toArray in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    toArray in class AbstractCollection<E extends Schedule.Event>
  - toArray
```
public final <T> T[] toArray(T[] array)
```
    Specified by:
    
    toArray in interface Collection<E extends Schedule.Event>
    
    Specified by:
    
    toArray in interface Set<E extends Schedule.Event>
    
    Overrides:
    
    toArray in class AbstractCollection<E extends Schedule.Event>
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class AbstractCollection<E extends Schedule.Event>
  - cancelWait
```
protected void cancelWait()
```
    Cancels wait.
  - getEvents
```
@Nonnull
 @CheckReturnValue
protected NavigableSet<E> getEvents()
```
    Gets the events.
    
    Returns:
    
    The events.
  - getMutex
```
@Nonnull
 @CheckReturnValue
protected final Object getMutex()
```
    Gets the mutex.
    
    Returns:
    
    The mutex.
  - next
```
@Nonnull
 @CheckReturnValue
protected final Optional<E> next(boolean wait)
                                                        throws InterruptedException
```
    Returns the next event.
    Note: must be called while synchronized on getMutex().
    
    Parameters:
    
    wait - True to wait.
    
    Returns:
    
    The next event (empty if none without wait)
    
    Throws:
    
    InterruptedException - When interrupted.
  - rollback
```
protected final void rollback()
```
    Rolls back the latest call to next(boolean).

Class Schedule<E extends Schedule.Event>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class AbstractCollection

Methods inherited from class Object

Methods inherited from interface Iterator

Methods inherited from interface Set

Methods inherited from interface Collection

Methods inherited from interface Iterable

Constructor Detail

Schedule

Method Detail

add

advance

cancel

clear

contains

containsAll

equals

getDelay

hasNext

hashCode

isEmpty

iterator

next

peek

remove

remove

removeAll

retainAll

size

toArray

toArray

toString

cancelWait

getEvents

getMutex

next

rollback