SMailCallbackContext (MailFlute 0.6.4 API)

java.lang.Object
- org.dbflute.mail.send.hook.SMailCallbackContext

```
public class SMailCallbackContext
extends Object
```
導入されたバージョン:

0.5.2 (2016/12/04 Sunday)

作成者:

jflute

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`protected static class`	`SMailCallbackContext.InheritablePreparedMessageHook`
`static interface`	`SMailCallbackContext.SMailCallbackContextHolder` The holder of for callback context.

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected static SMailCallbackContext.SMailCallbackContextHolder`	`_defaultHolder` The default holder for callback context, using thread local.
`protected static ThreadLocal<SMailCallbackContext>`	`_defaultThreadLocal` The default thread-local for this.
`protected static SMailCallbackContext.SMailCallbackContextHolder`	`_holder` The holder for callback context, might be changed.
`protected static boolean`	`_locked` Is this static world locked?
`protected SMailPreparedMessageHook`	`_preparedMessageHook`

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

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

SMailCallbackContext()

コンストラクタ
コンストラクタと説明
`SMailCallbackContext()`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected static void`	`assertNotLocked()` Assert this is not locked.
`static void`	`clearCallbackContextOnThread()` Clear callback context on thread.
`protected static void`	`clearIfNoInterface(SMailCallbackContext context)`
`static void`	`clearPreparedMessageHookOnThread()`
`protected SMailCallbackContext.InheritablePreparedMessageHook`	`createInheritablePreparedMessageHook(SMailPreparedMessageHook preparedMessageHook)`
`protected static SMailCallbackContext.SMailCallbackContextHolder`	`getActiveHolder()` Get the active holder for callback context.
`static SMailCallbackContext`	`getCallbackContextOnThread()` Get callback context on thread.
`protected static SMailCallbackContext`	`getOrCreateContext()`
`SMailPreparedMessageHook`	`getPreparedMessageHook()`
`boolean`	`hasAnyInterface()`
`static boolean`	`isExistCallbackContextOnThread()` Is existing callback context on thread?
`static boolean`	`isExistPreparedMessageHookOnThread()`
`static boolean`	`isLocked()` Is this static world locked?
`static void`	`lock()` Lock this static world, e.g. not to set the holder of thread-local.
`static void`	`setCallbackContextOnThread(SMailCallbackContext callbackContext)` Set callback context on thread.
`void`	`setPreparedMessageHook(SMailPreparedMessageHook preparedMessageHook)`
`static void`	`setPreparedMessageHookOnThread(SMailPreparedMessageHook preparedMessageHook)`
`String`	`toString()`
`static void`	`unlock()` Unlock this static world, e.g. to set the holder of thread-local.
`static void`	`useSurrogateHolder(SMailCallbackContext.SMailCallbackContextHolder holder)` Use the surrogate holder for callback context.

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

- フィールドの詳細
  - _defaultThreadLocal
```
protected static final ThreadLocal<SMailCallbackContext> _defaultThreadLocal
```
    The default thread-local for this.
  - _defaultHolder
```
protected static final SMailCallbackContext.SMailCallbackContextHolder _defaultHolder
```
    The default holder for callback context, using thread local. (NotNull)
  - _holder
```
protected static SMailCallbackContext.SMailCallbackContextHolder _holder
```
    The holder for callback context, might be changed. (NotNull: null setting is not allowed)
  - _locked
```
protected static boolean _locked
```
    Is this static world locked? e.g. you should unlock it to set your own provider.
  - _preparedMessageHook
```
protected SMailPreparedMessageHook _preparedMessageHook
```
- コンストラクタの詳細
  - SMailCallbackContext
```
public SMailCallbackContext()
```
- メソッドの詳細
  - getCallbackContextOnThread
```
public static SMailCallbackContext getCallbackContextOnThread()
```
    Get callback context on thread.
    
    戻り値:
    
    The context of callback. (NullAllowed)
  - setCallbackContextOnThread
```
public static void setCallbackContextOnThread(SMailCallbackContext callbackContext)
```
    Set callback context on thread.
    You can use setting methods per interface instead of this method.
    
    パラメータ:
    
    callbackContext - The context of callback. (NotNull)
  - isExistCallbackContextOnThread
```
public static boolean isExistCallbackContextOnThread()
```
    Is existing callback context on thread?
    You can use determination methods per interface instead of this method.
    
    戻り値:
    
    The determination, true or false.
  - clearCallbackContextOnThread
```
public static void clearCallbackContextOnThread()
```
    Clear callback context on thread.
    Basically you should call other clear methods per interfaces, because this clear method clears all interfaces.
  - getActiveHolder
```
protected static SMailCallbackContext.SMailCallbackContextHolder getActiveHolder()
```
    Get the active holder for callback context.
    
    戻り値:
    
    The holder instance to handle callback context. (NotNull)
  - useSurrogateHolder
```
public static void useSurrogateHolder(SMailCallbackContext.SMailCallbackContextHolder holder)
```
    Use the surrogate holder for callback context. (automatically locked after setting)
    You should call this in application initialization if it needs.
    
    パラメータ:
    
    holder - The holder instance. (NullAllowed: if null, use default holder)
  - isLocked
```
public static boolean isLocked()
```
    Is this static world locked?
    
    戻り値:
    
    The determination, true or false.
  - lock
```
public static void lock()
```
    Lock this static world, e.g. not to set the holder of thread-local.
  - unlock
```
public static void unlock()
```
    Unlock this static world, e.g. to set the holder of thread-local.
  - assertNotLocked
```
protected static void assertNotLocked()
```
    Assert this is not locked.
  - setPreparedMessageHookOnThread
```
public static void setPreparedMessageHookOnThread(SMailPreparedMessageHook preparedMessageHook)
```
  - isExistPreparedMessageHookOnThread
```
public static boolean isExistPreparedMessageHookOnThread()
```
  - clearPreparedMessageHookOnThread
```
public static void clearPreparedMessageHookOnThread()
```
  - getOrCreateContext
```
protected static SMailCallbackContext getOrCreateContext()
```
  - clearIfNoInterface
```
protected static void clearIfNoInterface(SMailCallbackContext context)
```
  - hasAnyInterface
```
public boolean hasAnyInterface()
```
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - getPreparedMessageHook
```
public SMailPreparedMessageHook getPreparedMessageHook()
```
  - setPreparedMessageHook
```
public void setPreparedMessageHook(SMailPreparedMessageHook preparedMessageHook)
```
  - createInheritablePreparedMessageHook
```
protected SMailCallbackContext.InheritablePreparedMessageHook createInheritablePreparedMessageHook(SMailPreparedMessageHook preparedMessageHook)
```

クラス SMailCallbackContext

ネストされたクラスのサマリー

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

_defaultThreadLocal

_defaultHolder

_holder

_locked

_preparedMessageHook

コンストラクタの詳細

SMailCallbackContext

メソッドの詳細

getCallbackContextOnThread

setCallbackContextOnThread

isExistCallbackContextOnThread

clearCallbackContextOnThread

getActiveHolder

useSurrogateHolder

isLocked

lock

unlock

assertNotLocked

setPreparedMessageHookOnThread

isExistPreparedMessageHookOnThread

clearPreparedMessageHookOnThread

getOrCreateContext

clearIfNoInterface

hasAnyInterface

toString

getPreparedMessageHook

setPreparedMessageHook

createInheritablePreparedMessageHook