CellFormatResult (Excel-CellFormatter 0.12 API)

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

```
public class CellFormatResult
extends Object
```
フォーマット結果を保持するクラス。
条件に色が付与されている場合などの情報を保持する。

バージョン:

0.6

作成者:

T.TSUCHIE

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

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

CellFormatResult()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`FormatCellType`	`getCellType()` セルの種類を取得する各メソッド`isText()`などのisXXX()メソッドの判定に利用する。
`String`	`getSectionPattern()` フォーマットの際、一致した書式内のセクションの書式を返す。
`String`	`getText()` フォーマットした文字列を取得する
`MSColor`	`getTextColor()` 文字色を取得する。
`Object`	`getValue()` フォーマット対象の値を取得する。
`boolean`	`getValueAsBoolean()` フォーマット対象の値をブール型として取得する。
`Date`	`getValueAsDate()` フォーマット対象の値を日時型として取得する。
`Date`	`getValueAsDate(TimeZone tz)` タイムゾーンを指定して、フォーマット対象の値を日時型として取得する。
`double`	`getValueAsDoulbe()` フォーマット対象の値をdouble型として取得する。
`String`	`getValueAsString()` フォーマット対象の値を文字列型として取得する。
`boolean`	`isBlank()` 値がブランクかどうか。
`boolean`	`isBoolean()` 値がブール値かどうか
`boolean`	`isDate()` 値が日付型かどうか。
`boolean`	`isError()` 値がエラー型かどうか。
`boolean`	`isNumber()` 値が数値型かどうか。
`boolean`	`isText()` 値が文字列型かどうか。
`void`	`setCellType(FormatCellType cellType)` セルの種類を設定する。
`void`	`setSectionPattern(String sectionPattern)` フォーマットの際、一致した書式内のセクションの書式を設定する
`void`	`setText(String text)` フォーマットした文字列を設定する
`void`	`setTextColor(MSColor textColor)` 書式の文字色を設定する。
`void`	`setValue(Object value)` フォーマット対象の値を設定する。

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

- コンストラクタの詳細
  - CellFormatResult
```
public CellFormatResult()
```
- メソッドの詳細
  - getValue
```
public Object getValue()
```
    フォーマット対象の値を取得する。
    具体的に値を取得する際には、キャストして利用する。
    
    戻り値:
    
    フォーマット対象の値。
  - getValueAsDoulbe
```
public double getValueAsDoulbe()
```
    フォーマット対象の値をdouble型として取得する。
    
    戻り値:
    
    数値の値を返す。isNumber()の値がtrueの時に値が取得可能。
    
    例外:
    
    ClassCastException - 書式が一致しない場合
  - getValueAsDate
```
public Date getValueAsDate()
```
    フォーマット対象の値を日時型として取得する。
    
    戻り値:
    
    タイムゾーンが考慮された日時です。タイムゾーンはデフォルトです。 isDate()の値がtrueの時に値が取得可能。
    
    例外:
    
    ClassCastException - 書式が一致しない場合
  - getValueAsDate
```
public Date getValueAsDate(TimeZone tz)
```
    タイムゾーンを指定して、フォーマット対象の値を日時型として取得する。
    
    パラメータ:
    
    tz - タイムゾーン。値がnullの場合は、デフォルトを使用します。
    
    戻り値:
    
    タイムゾーンを考慮した日時オブジェクト。 isDate()の値がtrueの時に値が取得可能。
    
    例外:
    
    ClassCastException - 書式が一致しない場合
    
    導入されたバージョン:
    
    0.6
  - getValueAsString
```
public String getValueAsString()
```
    フォーマット対象の値を文字列型として取得する。
    
    戻り値:
    
    文字列の値。isText()の値がtrueの時に値が取得可能。
    
    例外:
    
    ClassCastException - 書式が一致しない場合
  - getValueAsBoolean
```
public boolean getValueAsBoolean()
```
    フォーマット対象の値をブール型として取得する。
    
    戻り値:
    
    isBoolean()の値がtrueの時に値が取得可能。
    
    例外:
    
    ClassCastException - 書式が一致しない場合
  - isBlank
```
public boolean isBlank()
```
    値がブランクかどうか。
    
    戻り値:
    
    true:空。
  - isBoolean
```
public boolean isBoolean()
```
    値がブール値かどうか
    
    戻り値:
    
    true：ブール型の場合
  - isDate
```
public boolean isDate()
```
    値が日付型かどうか。
    
    戻り値:
    
    true:日時型の場合。
  - isNumber
```
public boolean isNumber()
```
    値が数値型かどうか。
    
    戻り値:
    
    true:数値型の場合。
  - isText
```
public boolean isText()
```
    値が文字列型かどうか。
    
    戻り値:
    
    true:文字列型の場合。
  - isError
```
public boolean isError()
```
    値がエラー型かどうか。
    
    戻り値:
    
    true:エラーの場合。
  - setValue
```
public void setValue(Object value)
```
    フォーマット対象の値を設定する。
    
    パラメータ:
    
    value - 値。
  - getTextColor
```
public MSColor getTextColor()
```
    文字色を取得する。
    
    戻り値:
    
    書式に色が適用されていない場合は、nullを返す。
  - setTextColor
```
public void setTextColor(MSColor textColor)
```
    書式の文字色を設定する。
    
    パラメータ:
    
    textColor - 文字色。
  - getText
```
public String getText()
```
    フォーマットした文字列を取得する
    
    戻り値:
    
    フォーマットした文字列。
  - setText
```
public void setText(String text)
```
    フォーマットした文字列を設定する
    
    パラメータ:
    
    text -
  - getSectionPattern
```
public String getSectionPattern()
```
    フォーマットの際、一致した書式内のセクションの書式を返す。
    
    戻り値:
    
    一致したセクションの書式。
  - setSectionPattern
```
public void setSectionPattern(String sectionPattern)
```
    フォーマットの際、一致した書式内のセクションの書式を設定する
    
    パラメータ:
    
    sectionPattern - 一致したセクションの書式。
  - getCellType
```
public FormatCellType getCellType()
```
    セルの種類を取得する
    各メソッドisText()などのisXXX()メソッドの判定に利用する。
    
    戻り値:
    
    フォーマットした結果のセルの種類。
  - setCellType
```
public void setCellType(FormatCellType cellType)
```
    セルの種類を設定する。
    
    パラメータ:
    
    cellType -

クラス CellFormatResult

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

メソッドのサマリー

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

コンストラクタの詳細

CellFormatResult

メソッドの詳細

getValue

getValueAsDoulbe

getValueAsDate

getValueAsDate

getValueAsString

getValueAsBoolean

isBlank

isBoolean

isDate

isNumber

isText

isError

setValue

getTextColor

setTextColor

getText

setText

getSectionPattern

setSectionPattern

getCellType

setCellType