Container (java 2.0.7 API)

java.lang.Object
- com.syntaxphoenix.syntaxapi.utils.java.tools.Container<T>

public final class Container<T>
extends Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<T>`	`asOptional()` returns the value as an optional
`static <T> Container<T>`	`empty()` Returns an empty `Container` instance.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this `Container`.
`Container<T>`	`filter(java.util.function.Predicate<? super T> predicate)` If a value is present, and the value matches the given predicate, returns an `Container` describing the value, otherwise returns an empty `Container`.
`<U> Container<U>`	`flatMap(java.util.function.Function<? super T,? extends Container<? extends U>> mapper)` If a value is present, returns the result of applying the given `Container`-bearing mapping function to the value, otherwise returns an empty `Container`.
`T`	`get()` returns the value
`int`	`hashCode()` Returns the hash code of the value, if present, otherwise `0` (zero) if no value is present.
`void`	`ifPresent(java.util.function.Consumer<? super T> action)` If a value is present, performs the given action with the value, otherwise does nothing.
`void`	`ifPresentOrElse(java.util.function.Consumer<? super T> action, Runnable emptyAction)` If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
`boolean`	`isEmpty()` If a value is not present, returns `true`, otherwise `false`.
`boolean`	`isModifiable()` returns the modifiable
`boolean`	`isPresent()` If a value is present, returns `true`, otherwise `false`.
`Container<T>`	`lock()` locks the container
`<U> Container<U>`	`map(java.util.function.Function<? super T,? extends U> mapper)` If a value is present, returns an `Container` describing the result of applying the given mapping function to the value, otherwise returns an empty `Container`.
`static <T> Container<T>`	`of()` Returns an `Container`
`static <T> Container<T>`	`of(T value)` Returns an `Container` describing the given value.
`static <T> Container<T>`	`ofOptional(Optional<T> value)` Returns an `Container` describing the given value of the optional.
`static <T> Container<T>`	`ofOptionalUnmodifiable(Optional<T> value)` Returns an `Container` describing the given value of the optional.
`static <T> Container<T>`	`ofUnmodifiable(T value)` Returns an `Container` describing the given value.
`Container<T>`	`or(java.util.function.Supplier<? extends Container<? extends T>> supplier)` If a value is present, returns an `Container` describing the value, otherwise returns an `Container` produced by the supplying function.
`T`	`orElse(T other)` If a value is present, returns the value, otherwise returns `other`.
`T`	`orElseGet(java.util.function.Supplier<? extends T> supplier)` If a value is present, returns the value, otherwise returns the result produced by the supplying function.
`T`	`orElseThrow()` If a value is present, returns the value, otherwise throws `NoSuchElementException`.
`<X extends Throwable> T`	`orElseThrow(java.util.function.Supplier<? extends X> exceptionSupplier)` If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.
`Container<T>`	`replace(T value)` replaces the value with the given value
`java.util.stream.Stream<T>`	`stream()` If a value is present, returns a sequential `Stream` containing only that value, otherwise returns an empty `Stream`.
`String`	`toString()` Returns a non-empty string representation of this `Container` suitable for debugging.

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

- Method Detail
  - empty
```
public static <T> Container<T> empty()
```
    Returns an empty Container instance. No value is present for this Container.
    
    Type Parameters:
    
    T - The type of the non-existent value
    
    Returns:
    
    an empty Container
  - of
```
public static <T> Container<T> of()
```
    Returns an Container
    
    Type Parameters:
    
    T - the type of the value
    
    Returns:
    
    an Container
  - of
```
public static <T> Container<T> of(T value)
```
    Returns an Container describing the given value.
    
    Type Parameters:
    
    T - the type of the value
    
    Parameters:
    
    value - the value to describe
    
    Returns:
    
    an Container with the value
  - ofUnmodifiable
```
public static <T> Container<T> ofUnmodifiable(T value)
```
    Returns an Container describing the given value.
    
    Type Parameters:
    
    T - the type of the value
    
    Parameters:
    
    value - the value to describe
    
    Returns:
    
    an unmodifiable Container with the value or empty
  - ofOptional
```
public static <T> Container<T> ofOptional(Optional<T> value)
```
    Returns an Container describing the given value of the optional.
    
    Type Parameters:
    
    T - the type of the value
    
    Parameters:
    
    value - {code Optional} that contains a value or null
    
    Returns:
    
    an Container with the value of the optional
  - ofOptionalUnmodifiable
```
public static <T> Container<T> ofOptionalUnmodifiable(Optional<T> value)
```
    Returns an Container describing the given value of the optional.
    
    Type Parameters:
    
    T - the type of the value
    
    Parameters:
    
    value - {code Optional} that contains a value or null
    
    Returns:
    
    an Container with the value of the optional
  - asOptional
```
public Optional<T> asOptional()
```
    returns the value as an optional
    
    Returns:
    
    the optional
  - replace
```
public Container<T> replace(T value)
```
    replaces the value with the given value
    
    Parameters:
    
    value - the value to describe
    
    Returns:
    
    the old value described by this Container
  - get
```
public T get()
```
    returns the value
    
    Returns:
    
    the value described by this Container
  - lock
```
public Container<T> lock()
```
    locks the container
    
    Returns:
    
    this
  - isModifiable
```
public boolean isModifiable()
```
    returns the modifiable
    
    Returns:
    
    true if a value is present, otherwise false
  - isPresent
```
public boolean isPresent()
```
    If a value is present, returns true, otherwise false.
    
    Returns:
    
    true if a value is present, otherwise false
  - isEmpty
```
public boolean isEmpty()
```
    If a value is not present, returns true, otherwise false.
    
    Returns:
    
    true if a value is not present, otherwise false
  - ifPresent
```
public void ifPresent(java.util.function.Consumer<? super T> action)
```
    If a value is present, performs the given action with the value, otherwise does nothing.
    
    Parameters:
    
    action - the action to be performed, if a value is present
    
    Throws:
    
    NullPointerException - if value is present and the given action is null
  - ifPresentOrElse
```
public void ifPresentOrElse(java.util.function.Consumer<? super T> action,
                            Runnable emptyAction)
```
    If a value is present, performs the given action with the value, otherwise performs the given empty-based action.
    
    Parameters:
    
    action - the action to be performed, if a value is present
    
    emptyAction - the empty-based action to be performed, if no value is present
    
    Throws:
    
    NullPointerException - if a value is present and the given action is null, or no value is present and the given empty-based action is null.
  - filter
```
public Container<T> filter(java.util.function.Predicate<? super T> predicate)
```
    If a value is present, and the value matches the given predicate, returns an Container describing the value, otherwise returns an empty Container.
    
    Parameters:
    
    predicate - the predicate to apply to a value, if present
    
    Returns:
    
    an Container describing the value of this Container, if a value is present and the value matches the given predicate, otherwise an empty Container
    
    Throws:
    
    NullPointerException - if the predicate is null
  - map
```
public <U> Container<U> map(java.util.function.Function<? super T,? extends U> mapper)
```
    If a value is present, returns an Container describing the result of applying the given mapping function to the value, otherwise returns an empty Container.
    If the mapping function returns a null result then this method returns an empty Container.
    
    Type Parameters:
    
    U - The type of the value returned from the mapping function
    
    Parameters:
    
    mapper - the mapping function to apply to a value, if present
    
    Returns:
    
    an Container describing the result of applying a mapping function to the value of this Container, if a value is present, otherwise an empty Container
    
    Throws:
    
    NullPointerException - if the mapping function is null
  - flatMap
```
public <U> Container<U> flatMap(java.util.function.Function<? super T,? extends Container<? extends U>> mapper)
```
    If a value is present, returns the result of applying the given Container-bearing mapping function to the value, otherwise returns an empty Container.
    This method is similar to map(Function), but the mapping function is one whose result is already an Container, and if invoked, flatMap does not wrap it within an additional Container.
    
    Type Parameters:
    
    U - The type of value of the Container returned by the mapping function
    
    Parameters:
    
    mapper - the mapping function to apply to a value, if present
    
    Returns:
    
    the result of applying an Container-bearing mapping function to the value of this Container, if a value is present, otherwise an empty Container
    
    Throws:
    
    NullPointerException - if the mapping function is null or returns a null result
  - or
```
public Container<T> or(java.util.function.Supplier<? extends Container<? extends T>> supplier)
```
    If a value is present, returns an Container describing the value, otherwise returns an Container produced by the supplying function.
    
    Parameters:
    
    supplier - the supplying function that produces an Container to be returned
    
    Returns:
    
    returns an Container describing the value of this Container, if a value is present, otherwise an Container produced by the supplying function.
    
    Throws:
    
    NullPointerException - if the supplying function is null or produces a null result
  - stream
```
public java.util.stream.Stream<T> stream()
```
    If a value is present, returns a sequential Stream containing only that value, otherwise returns an empty Stream.
    
    Returns:
    
    the optional value as a Stream
  - orElse
```
public T orElse(T other)
```
    If a value is present, returns the value, otherwise returns other.
    
    Parameters:
    
    other - the value to be returned, if no value is present. May be null.
    
    Returns:
    
    the value, if present, otherwise other
  - orElseGet
```
public T orElseGet(java.util.function.Supplier<? extends T> supplier)
```
    If a value is present, returns the value, otherwise returns the result produced by the supplying function.
    
    Parameters:
    
    supplier - the supplying function that produces a value to be returned
    
    Returns:
    
    the value, if present, otherwise the result produced by the supplying function
    
    Throws:
    
    NullPointerException - if no value is present and the supplying function is null
  - orElseThrow
```
public T orElseThrow()
```
    If a value is present, returns the value, otherwise throws NoSuchElementException.
    
    Returns:
    
    the non-null value described by this Container
    
    Throws:
    
    NoSuchElementException - if no value is present
  - orElseThrow
```
public <X extends Throwable> T orElseThrow(java.util.function.Supplier<? extends X> exceptionSupplier)
                                    throws X extends Throwable
```
    If a value is present, returns the value, otherwise throws an exception produced by the exception supplying function.
    
    Type Parameters:
    
    X - Type of the exception to be thrown
    
    Parameters:
    
    exceptionSupplier - the supplying function that produces an exception to be thrown
    
    Returns:
    
    the value, if present
    
    Throws:
    
    X - if no value is present
    
    NullPointerException - if no value is present and the exception supplying function is null
    
    X extends Throwable
  - equals
```
public boolean equals(Object obj)
```
    Indicates whether some other object is "equal to" this Container. The other object is considered equal if:
    - it is also an Container and;
    - both instances have no value present or;
    - the present values are "equal to" each other via equals().
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - an object to be tested for equality
    
    Returns:
    
    true if the other object is "equal to" this object otherwise false
  - hashCode
```
public int hashCode()
```
    Returns the hash code of the value, if present, otherwise 0 (zero) if no value is present.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hash code value of the present value or 0 if no value is present
  - toString
```
public String toString()
```
    Returns a non-empty string representation of this Container suitable for debugging. The exact presentation format is unspecified and may vary between implementations and versions.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of this instance

Class Container<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

of

ofUnmodifiable

ofOptional

ofOptionalUnmodifiable

asOptional

replace

get

lock

isModifiable

isPresent

isEmpty

ifPresent

ifPresentOrElse

filter

map

flatMap

or

stream

orElse

orElseGet

orElseThrow

orElseThrow

equals

hashCode

toString