Class Optional<T>

A container object which may or may not contain a non-null value.

Type Parameters

T

the type of the value

Hierarchy

Optional

Index

Constructors

Properties

Methods

get ifPresent ifPresentOrElse isEmpty isPresent orElse orElseThrow empty of ofNullable

Constructors

`Private` constructor

new Optional<T>(value): Optional<T>
Type Parameters
- T
Parameters
- value: T
Returns Optional<T>
- Defined in src/main/Optional.ts:14

Properties

`Private` `Readonly` value

value: T

Methods

get

get(): T
Returns the value if present or empty optional throws NoSuchElementException.

Returns T
- Defined in src/main/Optional.ts:35

ifPresent

ifPresent(action): void
Performs the given action with the value, otherwise does nothing.
Parameters
- action: ((value) => void)
  
  the action to be performed
  - - (value): void
    - Parameters
      
      value: T
      
      Returns void
Returns void

Throws
NullPointerException if given action is null
- Defined in src/main/Optional.ts:61

ifPresentOrElse

ifPresentOrElse(action, emptyAction): void
Performs the given action with the value, otherwise performs the given empty-based action.
Parameters
- action: ((value) => void)
  
  the action to be performed if value is present
  - - (value): void
    - Parameters
      
      value: T
      
      Returns void
- emptyAction: (() => void)
  
  the empty-based action to be performed if value is absent
  - - (): void
    - Returns void
Returns void

Throws
NullPointerException if value is present and the given action is null, or value is absent and the given empty-based action is null
- Defined in src/main/Optional.ts:75

isEmpty

isEmpty(): boolean
Returns status of value absence.

Returns boolean
- Defined in src/main/Optional.ts:28

isPresent

isPresent(): boolean
Returns status of value presence.

Returns boolean
- Defined in src/main/Optional.ts:21

orElse

orElse(otherValue): T
Returns the value if present or else returns other value.
Parameters
- otherValue: T
  
  the value to be returned if value is absent
Returns T
- Defined in src/main/Optional.ts:51

orElseThrow

orElseThrow(): T
Returns the value if present or empty optional throws NoSuchElementException.

Returns T
- Defined in src/main/Optional.ts:42

`Static` empty

empty<T>(): Optional<Exclude<T, undefined>>
Returns an empty optional with no present value to get.
Type Parameters
- T
Returns Optional<Exclude<T, undefined>>
- Defined in src/main/Optional.ts:103

`Static` of

of<T>(value): Optional<Exclude<T, undefined>>
Returns an optional of given non-null value.
Type Parameters
- T
  
  the type of the value
Parameters
- value: T
  
  the value to describe
Returns Optional<Exclude<T, undefined>>

Throws
NullPointerException if value is null
- Defined in src/main/Optional.ts:86

`Static` ofNullable

ofNullable<T>(value): Optional<Exclude<T, undefined>>
Returns an optional of given non-null value, otherwise an empty optional.
Type Parameters
- T
Parameters
- value: T
Returns Optional<Exclude<T, undefined>>
- Defined in src/main/Optional.ts:94

Generated using TypeDoc