BaseOptional (DBFlute Runtime 1.1.0-sp2-RC1 API)

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

型パラメータ:

OBJ - The type of wrapped object in the optional object.

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

OptionalThing<OBJ>

直系の既知のサブクラス:

OptionalEntity, OptionalObject, OptionalScalar
```
public abstract class BaseOptional<OBJ>
extends Object
implements OptionalThing<OBJ>
```
The base class for optional object.

導入されたバージョン:

1.0.5F (2014/05/10 Saturday)

作成者:

jflute, pull/23 (2015/03/04 Wednesday)

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected OBJ`	`_obj` The wrapped object for this optional object.
`protected OptionalThingExceptionThrower`	`_thrower` The exception thrower e.g. when wrapped object is not found.
`protected static OptionalThingIfPresentAfter`	`IF_PRESENT_AFTER_EMPTY`
`protected static OptionalThingIfPresentAfter`	`IF_PRESENT_AFTER_NONE_FIRE`

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

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

BaseOptional(OBJ obj, OptionalThingExceptionThrower thrower)

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

メソッドのサマリー

All Methods Instance Methods Abstract Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected void`	`callbackAlwaysPresent(OptionalThingConsumer<OBJ> objLambda)`
`protected OptionalThing<OBJ>`	`callbackFilter(OptionalThingPredicate<OBJ> mapper)`
`protected <RESULT> OptionalThing<RESULT>`	`callbackFlatMapping(OptionalThingFunction<? super OBJ,OptionalThing<RESULT>> mapper)`
`protected OptionalThingIfPresentAfter`	`callbackIfPresent(OptionalThingConsumer<OBJ> consumer)`
`protected <RESULT> OptionalThing<RESULT>`	`callbackMapping(OptionalThingFunction<? super OBJ,? extends RESULT> mapper)`
`protected abstract <ARG> OptionalThing<ARG>`	`createOptionalFilteredObject(ARG obj)`
`protected abstract <ARG> OptionalThing<ARG>`	`createOptionalFlatMappedObject(ARG obj)`
`protected abstract <ARG> OptionalThing<ARG>`	`createOptionalMappedObject(ARG obj)`
`protected OBJ`	`directlyGet()`
`protected OBJ`	`directlyGetOrElse(OBJ other)`
`protected OBJ`	`directlyGetOrElseGet(OptionalThingSupplier<OBJ> supplier)`
`protected <CAUSE extends Throwable> OBJ`	`directlyGetOrElseThrow(OptionalThingSupplier<? extends CAUSE> supplier)`
`boolean`	`equals(Object obj)`
`protected boolean`	`exists()` Is the wrapped object present?
`int`	`hashCode()`
`Optional<OBJ>`	`toOptional()` Convert to Java standard optional class.
`String`	`toString()`

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

インタフェースから継承されたメソッド org.dbflute.optional.OptionalThing
alwaysPresent, filter, flatMap, get, ifPresent, isPresent, map, orElse, orElseGet, orElseNull, orElseThrow

- フィールドの詳細
  - IF_PRESENT_AFTER_EMPTY
```
protected static final OptionalThingIfPresentAfter IF_PRESENT_AFTER_EMPTY
```
  - IF_PRESENT_AFTER_NONE_FIRE
```
protected static final OptionalThingIfPresentAfter IF_PRESENT_AFTER_NONE_FIRE
```
  - _obj
```
protected final OBJ _obj
```
    The wrapped object for this optional object. (NullAllowed)
  - _thrower
```
protected final OptionalThingExceptionThrower _thrower
```
    The exception thrower e.g. when wrapped object is not found. (NotNull)
- コンストラクタの詳細
  - BaseOptional
```
public BaseOptional(OBJ obj,
                    OptionalThingExceptionThrower thrower)
```
- メソッドの詳細
  - exists
```
protected boolean exists()
```
    Is the wrapped object present? (existing?)
    
    戻り値:
    
    The determination, true or false.
  - callbackAlwaysPresent
```
protected void callbackAlwaysPresent(OptionalThingConsumer<OBJ> objLambda)
```
    パラメータ:
    
    objLambda - The callback interface to consume the wrapped value. (NotNull)
  - callbackIfPresent
```
protected OptionalThingIfPresentAfter callbackIfPresent(OptionalThingConsumer<OBJ> consumer)
```
    パラメータ:
    
    consumer - The callback interface to consume the wrapped object. (NotNull)
    
    戻り値:
    
    The handler of after process when if not present. (NotNull)
  - directlyGet
```
protected OBJ directlyGet()
```
    戻り値:
    
    The object instance wrapped in this optional object. (NotNull)
  - directlyGetOrElse
```
protected OBJ directlyGetOrElse(OBJ other)
```
    パラメータ:
    
    other - The other instance to be returned if null. (NullAllowed: if null, returns null when entity is null)
    
    戻り値:
    
    The object instance wrapped in this optional object or specified value. (NullAllowed: if null specified)
  - directlyGetOrElseGet
```
protected OBJ directlyGetOrElseGet(OptionalThingSupplier<OBJ> supplier)
```
    パラメータ:
    
    supplier - The supplier of other instance if null. (NotNull)
    
    戻り値:
    
    The object instance wrapped in this optional object or specified value. (NullAllowed: if null specified)
  - directlyGetOrElseThrow
```
protected <CAUSE extends Throwable> OBJ directlyGetOrElseThrow(OptionalThingSupplier<? extends CAUSE> supplier)
                                                        throws CAUSE extends Throwable
```
    型パラメータ:
    
    CAUSE - The type of cause.
    
    パラメータ:
    
    supplier - 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
  - callbackFilter
```
protected OptionalThing<OBJ> callbackFilter(OptionalThingPredicate<OBJ> mapper)
```
    パラメータ:
    
    mapper - The callback interface to apply. (NotNull)
    
    戻り値:
    
    The optional thing as mapped result. (NotNull, EmptyOptionalAllowed: if not present or callback returns null)
  - createOptionalFilteredObject
```
protected abstract <ARG> OptionalThing<ARG> createOptionalFilteredObject(ARG 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)
  - callbackMapping
```
protected <RESULT> OptionalThing<RESULT> callbackMapping(OptionalThingFunction<? super OBJ,? extends RESULT> mapper)
```
    型パラメータ:
    
    RESULT - The type of mapping result.
    
    パラメータ:
    
    mapper - The callback interface to apply, null return allowed as empty. (NotNull)
    
    戻り値:
    
    The optional object as mapped result. (NotNull, EmptyOptionalAllowed: if not present or callback returns null)
  - createOptionalMappedObject
```
protected abstract <ARG> OptionalThing<ARG> createOptionalMappedObject(ARG 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)
  - callbackFlatMapping
```
protected <RESULT> OptionalThing<RESULT> callbackFlatMapping(OptionalThingFunction<? super OBJ,OptionalThing<RESULT>> mapper)
```
    型パラメータ:
    
    RESULT - The type of mapping result.
    
    パラメータ:
    
    mapper - The callback interface to apply, cannot return null. (NotNull)
    
    戻り値:
    
    The optional thing as flat-mapped result. (NotNull, EmptyOptionalAllowed: when not present)
  - createOptionalFlatMappedObject
```
protected abstract <ARG> OptionalThing<ARG> createOptionalFlatMappedObject(ARG 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)
  - toOptional
```
public Optional<OBJ> toOptional()
```
    Convert to Java standard optional class.
    For only when standard optional handling is needed, so basically you don't use this.
    
    定義:
    
    toOptional インタフェース内 OptionalThing<OBJ>
    
    戻り値:
    
    The new-created instance or empty. (NotNull)
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 Object
  - equals
```
public boolean equals(Object obj)
```
    オーバーライド:
    
    equals クラス内 Object
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object

クラス BaseOptional<OBJ>

フィールドのサマリー

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

メソッドのサマリー

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

インタフェースから継承されたメソッド org.dbflute.optional.OptionalThing

フィールドの詳細

IF_PRESENT_AFTER_EMPTY

IF_PRESENT_AFTER_NONE_FIRE

_obj

_thrower

コンストラクタの詳細

BaseOptional

メソッドの詳細

exists

callbackAlwaysPresent

callbackIfPresent

directlyGet

directlyGetOrElse

directlyGetOrElseGet

directlyGetOrElseThrow

callbackFilter

createOptionalFilteredObject

callbackMapping

createOptionalMappedObject

callbackFlatMapping

createOptionalFlatMappedObject

toOptional

hashCode

equals

toString