BaseOptional (DBFlute Runtime 1.2.5 API)

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

型パラメータ:

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

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

Serializable, OptionalThing<OBJ>

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

OptionalEntity, OptionalObject, OptionalScalar
```
public abstract class BaseOptional<OBJ>
extends Object
implements OptionalThing<OBJ>, Serializable
```
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)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`assertCauseLambdaNotNull(Object causeLambda)`
`protected void`	`assertNoArgLambdaNotNull(Object noArgLambda)`
`protected void`	`assertOneArgLambdaNotNull(Object oneArgLambda)`
`protected void`	`callbackAlwaysPresent(OptionalThingConsumer<? super OBJ> objLambda)`
`protected OptionalThing<OBJ>`	`callbackFilter(OptionalThingPredicate<? super OBJ> mapper)`
`protected <RESULT> OptionalThing<RESULT>`	`callbackFlatMapping(OptionalThingFunction<? super OBJ,OptionalThing<RESULT>> mapper)`
`protected OBJ`	`callbackGetOrElseGet(OptionalThingSupplier<? extends OBJ> supplier)`
`protected <CAUSE extends Throwable> OBJ`	`callbackGetOrElseThrow(OptionalThingSupplier<? extends CAUSE> supplier)`
`protected <CAUSE extends Throwable,TRANSLATED extends Throwable> OBJ`	`callbackGetOrElseTranslatingThrow(OptionalThingFunction<CAUSE,TRANSLATED> translator)`
`protected OptionalThingIfPresentAfter`	`callbackIfPresent(OptionalThingConsumer<? super OBJ> consumer)`
`protected void`	`callbackIfPresentOrElse(OptionalThingConsumer<? super OBJ> presentAction, IndependentProcessor emptyAction)`
`protected <RESULT> OptionalThing<RESULT>`	`callbackMapping(OptionalThingFunction<? super OBJ,? extends RESULT> mapper)`
`protected OptionalThing<OBJ>`	`callbackOr(OptionalThingSupplier<? extends OptionalThing<? extends OBJ>> supplier)`
`protected Stream<OBJ>`	`convertToStream()`
`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 boolean`	`determineEmpty()`
`protected boolean`	`determinePresent()`
`protected OBJ`	`directlyGet()`
`protected OBJ`	`directlyGetOrElse(OBJ other)`
`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, empty, filter, flatMap, get, ifPresent, ifPresentOrElse, isEmpty, isPresent, map, migratedFrom, of, ofNullable, or, orElse, orElseGet, orElseThrow, orElseThrow, orElseTranslatingThrow, stream, translatedFrom

- フィールドの詳細
  - 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.
  - callbackIfPresent
```
protected OptionalThingIfPresentAfter callbackIfPresent(OptionalThingConsumer<? super OBJ> consumer)
```
    パラメータ:
    
    consumer - The callback interface to consume the wrapped object. (NotNull)
    
    戻り値:
    
    The handler of after process when if not present. (NotNull)
  - callbackIfPresentOrElse
```
protected void callbackIfPresentOrElse(OptionalThingConsumer<? super OBJ> presentAction,
                                       IndependentProcessor emptyAction)
```
  - determinePresent
```
protected boolean determinePresent()
```
    戻り値:
    
    Is the optional object present?
  - determineEmpty
```
protected boolean determineEmpty()
```
    戻り値:
    
    Is the optional object empty (not present)?
  - directlyGet
```
protected OBJ directlyGet()
```
    戻り値:
    
    The object instance wrapped in this optional object. (NotNull)
  - callbackOr
```
protected OptionalThing<OBJ> callbackOr(OptionalThingSupplier<? extends OptionalThing<? extends OBJ>> supplier)
```
    パラメータ:
    
    supplier - The supplier of other optional if not present. (NotNull)
    
    戻り値:
    
    this or optional provided by supplier. (NotNull, EmptyAllowed: provided one may be empty)
  - directlyGetOrElse
```
protected OBJ directlyGetOrElse(OBJ other)
```
    パラメータ:
    
    other - The other instance to be returned if not present. (NullAllowed: if null, returns null when entity is null)
    
    戻り値:
    
    The object instance wrapped in this optional object or specified value. (NullAllowed: if null specified)
  - callbackGetOrElseGet
```
protected OBJ callbackGetOrElseGet(OptionalThingSupplier<? extends OBJ> supplier)
```
    パラメータ:
    
    supplier - The supplier of other instance if not present. (NotNull)
    
    戻り値:
    
    The object instance wrapped in this optional object or specified value. (NullAllowed: if null specified)
  - callbackGetOrElseThrow
```
protected <CAUSE extends Throwable> OBJ callbackGetOrElseThrow(OptionalThingSupplier<? extends CAUSE> supplier)
                                                        throws CAUSE extends Throwable
```
    型パラメータ:
    
    CAUSE - The type of cause.
    
    パラメータ:
    
    supplier - The supplier of exception if not present. (NotNull)
    
    戻り値:
    
    The object instance wrapped in this optional object. (NotNull: if null, exception)
    
    例外:
    
    CAUSE - When the value is null.
    
    CAUSE extends Throwable
  - callbackGetOrElseTranslatingThrow
```
protected <CAUSE extends Throwable,TRANSLATED extends Throwable> OBJ callbackGetOrElseTranslatingThrow(OptionalThingFunction<CAUSE,TRANSLATED> translator)
                                                                                                throws TRANSLATED extends Throwable
```
    型パラメータ:
    
    CAUSE - The type of original cause.
    
    TRANSLATED - The type of translated cause.
    
    パラメータ:
    
    translator - The translator function of exception if not present. (NotNull)
    
    戻り値:
    
    The object instance wrapped in this optional object. (NotNull: if null, exception)
    
    例外:
    
    TRANSLATED - When the value is null.
    
    TRANSLATED extends Throwable
  - callbackFilter
```
protected OptionalThing<OBJ> callbackFilter(OptionalThingPredicate<? super 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, returns 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, returns 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, returns empty optional)
    
    戻り値:
    
    The new-created instance of optional thing. (NotNull)
  - convertToStream
```
protected Stream<OBJ> convertToStream()
```
    戻り値:
    
    The stream for the optional thing, may be empty (if not present). (NotNull, EmptyAllowed: if not present)
  - callbackAlwaysPresent
```
protected void callbackAlwaysPresent(OptionalThingConsumer<? super OBJ> objLambda)
```
    パラメータ:
    
    objLambda - The callback interface to consume the wrapped value. (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)
  - assertCauseLambdaNotNull
```
protected void assertCauseLambdaNotNull(Object causeLambda)
```
  - assertOneArgLambdaNotNull
```
protected void assertOneArgLambdaNotNull(Object oneArgLambda)
```
  - assertNoArgLambdaNotNull
```
protected void assertNoArgLambdaNotNull(Object noArgLambda)
```
  - 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

callbackIfPresent

callbackIfPresentOrElse

determinePresent

determineEmpty

directlyGet

callbackOr

directlyGetOrElse

callbackGetOrElseGet

callbackGetOrElseThrow

callbackGetOrElseTranslatingThrow

callbackFilter

createOptionalFilteredObject

callbackMapping

createOptionalMappedObject

callbackFlatMapping

createOptionalFlatMappedObject

convertToStream

callbackAlwaysPresent

toOptional

assertCauseLambdaNotNull

assertOneArgLambdaNotNull

assertNoArgLambdaNotNull

hashCode

equals

toString