EnumSelector (NOVA-Core 0.1.0-SNAPSHOT API)

java.lang.Object
- nova.core.util.EnumSelector<T>

Type Parameters:

T - The enum

All Implemented Interfaces:

java.lang.Iterable<T>
```
public class EnumSelector<T extends java.lang.Enum<T>>
extends java.lang.Object
implements java.lang.Iterable<T>
```
This class is used to mark certain values from specified enum as allowed. Note that you must specify default state via #allowAll or #blockAll methods. Allows iteration of all allowed elements.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnumSelector<T>`	`allowAll()` Make the EnumSelector allow all for the given type by default.
`boolean`	`allows(T value)` Check if the `enum` value is allowed by this EnumSelector.
`boolean`	`allowsAll()` Check if the EnumSelector allows all values.
`EnumSelector<T>`	`apart(java.lang.Iterable<T> values)` Specify which `enum` values should have behavior opposite of the default
`EnumSelector<T>`	`apart(T... values)` Specify which `enum` values should have behavior opposite of the default
`EnumSelector<T>`	`apart(T value)` Specify which `enum` values should have behavior opposite of the default
`EnumSelector<T>`	`apart(T first, T second)` Specify which `enum` values should have behavior opposite of the default
`EnumSelector<T>`	`blockAll()` Make the EnumSelector block all for the given type by default.
`boolean`	`blocks(T value)` Check if the `enum` value is blocked by this EnumSelector.
`boolean`	`blocksAll()` Check if the EnumSelector blocks all values.
`boolean`	`equals(java.lang.Object other)`
`int`	`hashCode()`
`java.util.Iterator<T>`	`iterator()` Returns an iterator of all the allowed elements in this EnumSelector.
`EnumSelector<T>`	`lock()` Lock the EnumSelector, making it immutable.
`boolean`	`locked()` Check if the EnumSelector instance has been locked.
`static <T extends java.lang.Enum<T>> EnumSelector<T>`	`of(java.lang.Class<T> enumClass)` Creates a new instance of EnumSelector for the given type.
`java.util.stream.Stream<T>`	`parallelStream()` Returns a parallel stream of all the allowed elements in this EnumSelector.
`int`	`size()` Returns the count of all the allowed elements in this EnumSelector.
`java.util.Spliterator<T>`	`spliterator()` Returns a spliterator of all the allowed elements in this EnumSelector.
`java.util.stream.Stream<T>`	`stream()` Returns a sequential stream of all the allowed elements in this EnumSelector.
`java.util.Set<T>`	`toSet()` Returns a Set instance of all the allowed elements in this EnumSelector.
`java.lang.String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - of
```
public static <T extends java.lang.Enum<T>> EnumSelector<T> of(java.lang.Class<T> enumClass)
```
    Creates a new instance of EnumSelector for the given type.
    
    Type Parameters:
    
    T - The enum type
    
    Parameters:
    
    enumClass - The enum class for which to create an EnumSelector.
    
    Returns:
    
    an instance of EnumSelector for the given type.
  - allowAll
```
public EnumSelector<T> allowAll()
```
    Make the EnumSelector allow all for the given type by default.
    Use apart(java.lang.Enum) to specify what should be blocked.
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has been locked.
    
    See Also:
    
    blockAll(), apart(java.lang.Enum)
  - blockAll
```
public EnumSelector<T> blockAll()
```
    Make the EnumSelector block all for the given type by default.
    Use apart(java.lang.Enum) to specify what should be allowed.
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has been locked.
    
    See Also:
    
    allowAll(), apart(java.lang.Enum)
  - apart
```
public EnumSelector<T> apart(T value)
```
    Specify which enum values should have behavior opposite of the default
    
    Parameters:
    
    value - The given enum value that should have behavior opposite of the default.
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has been locked.
    
    See Also:
    
    allowAll(), blockAll()
  - apart
```
public EnumSelector<T> apart(T first,
                             T second)
```
    Specify which enum values should have behavior opposite of the default
    
    Parameters:
    
    first - The first enum value that should have behavior opposite of the default.
    
    second - The second enum value that should have behavior opposite of the default.
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has been locked.
    
    See Also:
    
    allowAll(), blockAll()
  - apart
```
public EnumSelector<T> apart(T... values)
```
    Specify which enum values should have behavior opposite of the default
    
    Parameters:
    
    values - The given enum values that should have behavior opposite of the default.
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has been locked.
    
    See Also:
    
    allowAll(), blockAll()
  - apart
```
public EnumSelector<T> apart(java.lang.Iterable<T> values)
```
    Specify which enum values should have behavior opposite of the default
    
    Parameters:
    
    values - The given enum values that should have behavior opposite of the default.
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has been locked, or if the values parameter is an EnumSelector instance which has not been locked.
    
    See Also:
    
    allowAll(), blockAll()
  - lock
```
public EnumSelector<T> lock()
```
    Lock the EnumSelector, making it immutable. Required for using of all getter methods.
    
    Returns:
    
    this
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector does not have specified default behavior.
    
    See Also:
    
    allowAll(), blockAll(), locked()
  - locked
```
public boolean locked()
```
    Check if the EnumSelector instance has been locked.
    
    Returns:
    
    The locked status.
  - allows
```
public boolean allows(T value)
```
    Check if the enum value is allowed by this EnumSelector.
    
    Parameters:
    
    value - The enum value to test.
    
    Returns:
    
    If the enum value is allowed by this EnumSelector.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - allowsAll
```
public boolean allowsAll()
```
    Check if the EnumSelector allows all values.
    
    Returns:
    
    If the EnumSelector allows all values.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - blocks
```
public boolean blocks(T value)
```
    Check if the enum value is blocked by this EnumSelector.
    
    Parameters:
    
    value - The enum value to test.
    
    Returns:
    
    If the enum value is blocked by this EnumSelector.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - blocksAll
```
public boolean blocksAll()
```
    Check if the EnumSelector blocks all values.
    
    Returns:
    
    If the EnumSelector blocks all values.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - iterator
```
public java.util.Iterator<T> iterator()
```
    Returns an iterator of all the allowed elements in this EnumSelector.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<T extends java.lang.Enum<T>>
    
    Returns:
    
    The iterator.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - spliterator
```
public java.util.Spliterator<T> spliterator()
```
    Returns a spliterator of all the allowed elements in this EnumSelector.
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<T extends java.lang.Enum<T>>
    
    Returns:
    
    The spliterator.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - stream
```
public java.util.stream.Stream<T> stream()
```
    Returns a sequential stream of all the allowed elements in this EnumSelector.
    
    Returns:
    
    The stream.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - parallelStream
```
public java.util.stream.Stream<T> parallelStream()
```
    Returns a parallel stream of all the allowed elements in this EnumSelector.
    
    Returns:
    
    The stream.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - toSet
```
public java.util.Set<T> toSet()
```
    Returns a Set instance of all the allowed elements in this EnumSelector.
    
    Returns:
    
    The set.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - size
```
public int size()
```
    Returns the count of all the allowed elements in this EnumSelector.
    
    Returns:
    
    The count.
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The same result as calling toSet().toString().
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
    
    See Also:
    
    AbstractCollection.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The hash calculated from toSet().hashCode().
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
    
    See Also:
    
    AbstractSet.hashCode()
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    true if this EnumSelector allows the exact same values as the other EnumSelector
    
    Throws:
    
    java.lang.IllegalStateException - If the EnumSelector has not been locked.
    
    See Also:
    
    AbstractSet.equals(Object)

Class EnumSelector<T extends java.lang.Enum<T>>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

of

allowAll

blockAll

apart

apart

apart

apart

lock

locked

allows

allowsAll

blocks

blocksAll

iterator

spliterator

stream

parallelStream

toSet

size

toString

hashCode

equals