ConditionFormatter (Excel-CellFormatter 0.12 API)

java.lang.Object
- com.github.mygreen.cellformatter.ConditionFormatter

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

ConditionDateFormatter, ConditionNumberFormatter, ConditionTextFormatter
```
public abstract class ConditionFormatter
extends Object
```
Excelのユーザ定義の各条件式を表現するための抽象クラス。
区切り文字';'で区切られたもの。

バージョン:

0.3

作成者:

T.TSUCHIE

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected List<Callback<?>>`	`callbacks` 処理後のコールバック
`protected MSColor`	`color` 条件の色
`protected List<String>`	`conditions` 全ての条件式
`protected MSLocale`	`locale` ロケール
`protected ConditionOperator`	`operator` 一致する条件
`protected String`	`pattern` 元の書式のパターン

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

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

ConditionFormatter(String pattern)

コンストラクタ
コンストラクタと説明
`ConditionFormatter(String pattern)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addAllCondition(List<String> conditions)` 複数の条件式を追加する。
`void`	`addCallback(Callback<?> callback)` コールバック処理を追加する。
`void`	`addCondition(String condition)` 条件式を追加する。
`void`	`addFirstCallcack(Callback<?> callback)` コールバック処理を先頭に追加する。
`CellFormatResult`	`format(CommonCell cell)` 値をフォーマットする。
`abstract CellFormatResult`	`format(CommonCell cell, Locale runtimeLocale)` ロケールを指定して値フォーマットする。
`List<Callback<?>>`	`getCallbacks()` コールバック処理を取得する
`MSColor`	`getColor()` 色を取得する。
`List<String>`	`getConditions()` 全ての条件式を取得する
`MSLocale`	`getLocale()` ロケールを取得する。
`ConditionOperator`	`getOperator()` 一致条件を取得する。
`String`	`getPattern()` 書式のパターンを取得する。
`abstract FormatterType`	`getType()` フォーマッタの種類を取得する。
`boolean`	`isDateFormatter()` 種類が'日時'のフォーマッタかどうか。
`abstract boolean`	`isMatch(CommonCell cell)` 値が条件に一致するかどうか。
`boolean`	`isNumberFormatter()` 種類が'数値'のフォーマッタかどうか。
`boolean`	`isTextFormatter()` 種類が'テキスト'のフォーマッタかどうか。
`void`	`setColor(MSColor color)` 色を設定する。
`void`	`setLocale(MSLocale locale)` ロケールを設定する。
`void`	`setOperator(ConditionOperator operator)` 一致条件を設定する。

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

- フィールドの詳細
  - pattern
```
protected final String pattern
```
    元の書式のパターン
  - operator
```
protected ConditionOperator operator
```
    一致する条件
  - locale
```
protected MSLocale locale
```
    ロケール
  - color
```
protected MSColor color
```
    条件の色
  - conditions
```
protected List<String> conditions
```
    全ての条件式
  - callbacks
```
protected List<Callback<?>> callbacks
```
    処理後のコールバック
- コンストラクタの詳細
  - ConditionFormatter
```
public ConditionFormatter(String pattern)
```
- メソッドの詳細
  - getType
```
public abstract FormatterType getType()
```
    フォーマッタの種類を取得する。
    
    戻り値:
  - isMatch
```
public abstract boolean isMatch(CommonCell cell)
```
    値が条件に一致するかどうか。
    ConditionOperatorに一致するかどうか。
    
    パラメータ:
    
    cell - 判定対象のセル。
    
    戻り値:
    
    true:一致する。
  - format
```
public CellFormatResult format(CommonCell cell)
```
    値をフォーマットする。
    
    パラメータ:
    
    cell - フォーマット対象のセル。
    
    戻り値:
    
    true:一致する。
  - format
```
public abstract CellFormatResult format(CommonCell cell,
                                        Locale runtimeLocale)
```
    ロケールを指定して値フォーマットする。
    
    パラメータ:
    
    cell - フォーマット対象のセル。
    
    runtimeLocale - 実行時のロケール。nullの場合は、実行環境のロケールが指定される。
    
    戻り値:
    
    フォーマット結果。
  - isDateFormatter
```
public boolean isDateFormatter()
```
    種類が'日時'のフォーマッタかどうか。
    
    戻り値:
  - isNumberFormatter
```
public boolean isNumberFormatter()
```
    種類が'数値'のフォーマッタかどうか。
    
    戻り値:
  - isTextFormatter
```
public boolean isTextFormatter()
```
    種類が'テキスト'のフォーマッタかどうか。
    
    戻り値:
  - getPattern
```
public String getPattern()
```
    書式のパターンを取得する。
    
    戻り値:
  - addCondition
```
public void addCondition(String condition)
```
    条件式を追加する。
    
    パラメータ:
    
    condition -
  - addAllCondition
```
public void addAllCondition(List<String> conditions)
```
    複数の条件式を追加する。
    
    パラメータ:
    
    conditions -
  - getConditions
```
public List<String> getConditions()
```
    全ての条件式を取得する
    
    戻り値:
  - getColor
```
public MSColor getColor()
```
    色を取得する。
    
    戻り値:
    
    値を持たない場合は、nullを返す。
  - setColor
```
public void setColor(MSColor color)
```
    色を設定する。
  - getOperator
```
public ConditionOperator getOperator()
```
    一致条件を取得する。
    
    戻り値:
  - setOperator
```
public void setOperator(ConditionOperator operator)
```
    一致条件を設定する。
    
    パラメータ:
    
    operator - 一致条件
  - getLocale
```
public MSLocale getLocale()
```
    ロケールを取得する。
    
    戻り値:
    
    値を持たない場合は、nullを返す。
  - setLocale
```
public void setLocale(MSLocale locale)
```
    ロケールを設定する。
    
    パラメータ:
    
    locale -
  - addCallback
```
public void addCallback(Callback<?> callback)
```
    コールバック処理を追加する。
    
    パラメータ:
    
    callback -
  - addFirstCallcack
```
public void addFirstCallcack(Callback<?> callback)
```
    コールバック処理を先頭に追加する。（優先度を高くする。）
  - getCallbacks
```
public List<Callback<?>> getCallbacks()
```
    コールバック処理を取得する
    
    戻り値:

クラス ConditionFormatter

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

pattern

operator

locale

color

conditions

callbacks

コンストラクタの詳細

ConditionFormatter

メソッドの詳細

getType

isMatch

format

format

isDateFormatter

isNumberFormatter

isTextFormatter

getPattern

addCondition

addAllCondition

getConditions

getColor

setColor

getOperator

setOperator

getLocale

setLocale

addCallback

addFirstCallcack

getCallbacks