OptionalObject (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.optional.BaseOptional<OBJ>
- - org.dbflute.optional.OptionalObject<OBJ>

型パラメータ:

OBJ - The type of object.

すべての実装されたインタフェース:

OptionalThing<OBJ>
```
public class OptionalObject<OBJ>
extends BaseOptional<OBJ>
```
導入されたバージョン:

1.1.0-sp1 (2015/01/19 Monday)

作成者:

jflute

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected static OptionalObject<Object> EMPTY_INSTANCE

protected static OptionalThingExceptionThrower NOWAY_THROWER
- クラスから継承されたフィールド org.dbflute.optional.BaseOptional
  _obj, _thrower, IF_PRESENT_AFTER_EMPTY, IF_PRESENT_AFTER_NONE_FIRE

フィールド
修飾子とタイプ	フィールドと説明
`protected static OptionalObject<Object>`	`EMPTY_INSTANCE`
`protected static OptionalThingExceptionThrower`	`NOWAY_THROWER`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

OptionalObject(OBJ thing, OptionalThingExceptionThrower thrower)

コンストラクタ
コンストラクタと説明
`OptionalObject(OBJ thing, OptionalThingExceptionThrower thrower)`

メソッドのサマリー

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
修飾子とタイプ	メソッドと説明
`void`	`alwaysPresent(OptionalThingConsumer<OBJ> oneArgLambda)` Handle the object in the optional thing or exception if not present.
`protected void`	`assertOneArgLambdaNotNull(Object oneArgLambda)`
`protected <ARG> OptionalObject<ARG>`	`createOptionalFilteredObject(ARG obj)`
`protected <ARG> OptionalObject<ARG>`	`createOptionalFlatMappedObject(ARG obj)`
`protected <ARG> OptionalObject<ARG>`	`createOptionalMappedObject(ARG obj)`
`static <EMPTY> OptionalObject<EMPTY>`	`empty()`
`OptionalObject<OBJ>`	`filter(OptionalThingPredicate<OBJ> oneArgLambda)` Filter the object by the predicate.
`<RESULT> OptionalThing<RESULT>`	`flatMap(OptionalThingFunction<? super OBJ,OptionalThing<RESULT>> oneArgLambda)` Apply the flat-mapping of object to result object.
`OBJ`	`get()` Get the thing or exception if null.
`OptionalThingIfPresentAfter`	`ifPresent(OptionalThingConsumer<OBJ> oneArgLambda)` Handle the wrapped thing if it is present.
`boolean`	`isPresent()` Is the object instance present?
`<RESULT> OptionalThing<RESULT>`	`map(OptionalThingFunction<? super OBJ,? extends RESULT> oneArgLambda)` Apply the mapping of object to result object.
`static <OBJ> OptionalObject<OBJ>`	`of(OBJ object)`
`static <OBJ> OptionalObject<OBJ>`	`ofNullable(OBJ object, OptionalThingExceptionThrower noArgLambda)`
`OBJ`	`orElse(OBJ other)` Get the wrapped instance or returns the specified thing.
`OBJ`	`orElseGet(OptionalThingSupplier<OBJ> noArgLambda)` Get the thing or get from the supplier.
`OBJ`	`orElseNull()` 非推奨です。 basically use ifPresent() or use orElse(null)
`<CAUSE extends Throwable> OBJ`	`orElseThrow(OptionalThingSupplier<? extends CAUSE> noArgLambda)` Get the thing or throw the exception.

クラスから継承されたメソッド org.dbflute.optional.BaseOptional
callbackAlwaysPresent, callbackFilter, callbackFlatMapping, callbackIfPresent, callbackMapping, directlyGet, directlyGetOrElse, directlyGetOrElseGet, directlyGetOrElseThrow, equals, exists, hashCode, toOptional, toString

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - EMPTY_INSTANCE
```
protected static final OptionalObject<Object> EMPTY_INSTANCE
```
  - NOWAY_THROWER
```
protected static final OptionalThingExceptionThrower NOWAY_THROWER
```
- コンストラクタの詳細
  - OptionalObject
```
public OptionalObject(OBJ thing,
                      OptionalThingExceptionThrower thrower)
```
    パラメータ:
    
    thing - The wrapped instance of thing. (NullAllowed)
    
    thrower - The exception thrower when illegal access. (NotNull)
- メソッドの詳細
  - empty
```
public static <EMPTY> OptionalObject<EMPTY> empty()
```
    型パラメータ:
    
    EMPTY - The type of empty optional object.
    
    戻り値:
    
    The fixed instance as empty. (NotNull)
  - of
```
public static <OBJ> OptionalObject<OBJ> of(OBJ object)
```
    型パラメータ:
    
    OBJ - The type of object wrapped in the optional object.
    
    パラメータ:
    
    object - The wrapped thing which is optional. (NotNull)
    
    戻り値:
    
    The new-created instance as existing optional object. (NotNull)
  - ofNullable
```
public static <OBJ> OptionalObject<OBJ> ofNullable(OBJ object,
                                                   OptionalThingExceptionThrower noArgLambda)
```
    型パラメータ:
    
    OBJ - The type of object wrapped in the optional object.
    
    パラメータ:
    
    object - The wrapped instance or thing. (NullAllowed)
    
    noArgLambda - The callback for exception when illegal access. (NotNull)
    
    戻り値:
    
    The new-created instance as existing or empty optional object. (NotNull)
  - ifPresent
```
public OptionalThingIfPresentAfter ifPresent(OptionalThingConsumer<OBJ> oneArgLambda)
```
    Handle the wrapped thing if it is present.
    You should call this if null object handling is unnecessary (do nothing if null).
    If exception is preferred when null object, use required().
    
    パラメータ:
    
    oneArgLambda - The callback interface to consume the optional thing. (NotNull)
    
    戻り値:
    
    The handler of after process when if not present. (NotNull)
  - isPresent
```
public boolean isPresent()
```
    Is the object instance present? (existing?)
    
    戻り値:
    
    The determination, true or false.
  - get
```
public OBJ get()
```
    Get the thing or exception if null.
    
    戻り値:
    
    The instance of the wrapped thing. (NotNull)
  - filter
```
public OptionalObject<OBJ> filter(OptionalThingPredicate<OBJ> oneArgLambda)
```
    Filter the object by the predicate.
    
    パラメータ:
    
    oneArgLambda - The callback to predicate whether the object is remained. (NotNull)
    
    戻り値:
    
    The filtered optional thing, might be empty. (NotNull)
  - createOptionalFilteredObject
```
protected <ARG> OptionalObject<ARG> createOptionalFilteredObject(ARG obj)
```
    定義:
    
    createOptionalFilteredObject クラス内 BaseOptional<OBJ>
    
    型パラメータ:
    
    ARG - The type of value for optional thing.
    
    パラメータ:
    
    obj - The plain object for the optional thing. (NullAllowed: if null, return s empty optional)
    
    戻り値:
    
    The new-created instance of optional thing. (NotNull)
  - map
```
public <RESULT> OptionalThing<RESULT> map(OptionalThingFunction<? super OBJ,? extends RESULT> oneArgLambda)
```
    Apply the mapping of object to result object.
    
    型パラメータ:
    
    RESULT - The type of mapping result.
    
    パラメータ:
    
    oneArgLambda - The callback interface to apply, null return allowed as empty. (NotNull)
    
    戻り値:
    
    The optional thing as mapped result. (NotNull, EmptyOptionalAllowed: if not present or callback returns null)
  - createOptionalMappedObject
```
protected <ARG> OptionalObject<ARG> createOptionalMappedObject(ARG obj)
```
    定義:
    
    createOptionalMappedObject クラス内 BaseOptional<OBJ>
    
    型パラメータ:
    
    ARG - The type of value for optional thing.
    
    パラメータ:
    
    obj - The plain object for the optional thing. (NullAllowed: if null, return s empty optional)
    
    戻り値:
    
    The new-created instance of optional thing. (NotNull)
  - flatMap
```
public <RESULT> OptionalThing<RESULT> flatMap(OptionalThingFunction<? super OBJ,OptionalThing<RESULT>> oneArgLambda)
```
    Apply the flat-mapping of object to result object.
    
    型パラメータ:
    
    RESULT - The type of mapping result.
    
    パラメータ:
    
    oneArgLambda - The callback interface to apply, cannot return null. (NotNull)
    
    戻り値:
    
    The optional thing as mapped result. (NotNull, EmptyOptionalAllowed: if not present or callback returns null)
  - createOptionalFlatMappedObject
```
protected <ARG> OptionalObject<ARG> createOptionalFlatMappedObject(ARG obj)
```
    定義:
    
    createOptionalFlatMappedObject クラス内 BaseOptional<OBJ>
    
    型パラメータ:
    
    ARG - The type of value for optional thing.
    
    パラメータ:
    
    obj - The plain object for the optional thing. (NullAllowed: if null, return s empty optional)
    
    戻り値:
    
    The new-created instance of optional thing. (NotNull)
  - orElse
```
public OBJ orElse(OBJ other)
```
    Get the wrapped instance or returns the specified thing.
    
    パラメータ:
    
    other - The object instance to be returned when the optional is empty. (NullAllowed)
    
    戻り値:
    
    The wrapped instance or specified other object. (NullAllowed:)
  - orElseGet
```
public OBJ orElseGet(OptionalThingSupplier<OBJ> noArgLambda)
```
    Get the thing or get from the supplier.
    
    パラメータ:
    
    noArgLambda - The supplier of other instance if null. (NotNull)
    
    戻り値:
    
    The object instance wrapped in this optional thing or specified value. (NullAllowed: if null specified)
  - orElseThrow
```
public <CAUSE extends Throwable> OBJ orElseThrow(OptionalThingSupplier<? extends CAUSE> noArgLambda)
                                          throws CAUSE extends Throwable
```
    Get the thing or throw the exception.
    
    型パラメータ:
    
    CAUSE - The type of cause.
    
    パラメータ:
    
    noArgLambda - The supplier of exception if null. (NotNull)
    
    戻り値:
    
    The object instance wrapped in this optional object. (NotNull: if null, exception)
    
    例外:
    
    CAUSE - When the value is null.
    
    CAUSE extends Throwable
  - alwaysPresent
```
public void alwaysPresent(OptionalThingConsumer<OBJ> oneArgLambda)
```
    Handle the object in the optional thing or exception if not present.
    
    パラメータ:
    
    oneArgLambda - The callback interface to consume the optional thing. (NotNull)
  - orElseNull
```
public OBJ orElseNull()
```
    非推奨です。 basically use ifPresent() or use orElse(null)
    
    Get the object instance or null if not present.
    basically use ifPresent() if might be not present, this is for emergency
    
    戻り値:
    
    The object instance wrapped in this optional thing or null. (NullAllowed: if not present)
  - assertOneArgLambdaNotNull
```
protected void assertOneArgLambdaNotNull(Object oneArgLambda)
```

クラス OptionalObject<OBJ>

フィールドのサマリー

クラスから継承されたフィールド org.dbflute.optional.BaseOptional

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.dbflute.optional.BaseOptional

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

EMPTY_INSTANCE

NOWAY_THROWER

コンストラクタの詳細

OptionalObject

メソッドの詳細

empty

of

ofNullable

ifPresent

isPresent

get

filter

createOptionalFilteredObject

map

createOptionalMappedObject

flatMap

createOptionalFlatMappedObject

orElse

orElseGet

orElseThrow

alwaysPresent

orElseNull

assertOneArgLambdaNotNull