CellPosition (XlsMapper 2.3 API)

java.lang.Object
- com.gh.mygreen.xlsmapper.util.CellPosition

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

Serializable, Cloneable, Comparable<CellPosition>
```
public class CellPosition
extends Object
implements Serializable, Comparable<CellPosition>, Cloneable
```
単一のセルのアドレスを表現するクラス。
Pointだと、行、列の表現がわかりづらくmutableなので、、その代わりに使用する。
CellReferenceとの違いは、セルのアドレスの絶対一致を表現するためのもの。
POIに同じ用途のクラスCellAddressが存在するが、こちらはSerializableやCloneableが実装されておらず、使い勝手が悪い。

導入されたバージョン:

1.4

作成者:

T.TSUCHIE

関連項目:

直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static CellPosition A1
シート上の先頭の位置を表現するための定数。

フィールド
修飾子とタイプ	フィールドと説明
`static CellPosition`	`A1` シート上の先頭の位置を表現するための定数。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`CellPosition`	`addColumn(int value)` 列番号に指定した値を加算する。
`CellPosition`	`addRow(int value)` 行番号に指定した値を加算する。
`CellPosition`	`clone()`
`int`	`compareTo(CellPosition other)`
`boolean`	`equals(Object obj)`
`String`	`formatAsString()` セルのアドレスを取得する。
`int`	`getColumn()` 列番号を取得する。
`int`	`getRow()` 行番号を取得する。
`int`	`hashCode()`
`static CellPosition`	`of(org.apache.poi.ss.usermodel.Cell cell)` CellAddressのインスタンスを作成する。
`static CellPosition`	`of(org.apache.poi.ss.util.CellAddress address)` CellAddressのインスタンスを作成する。
`static CellPosition`	`of(org.apache.poi.ss.util.CellReference reference)` CellAddressのインスタンスを作成する。
`static CellPosition`	`of(int row, int column)` CellAddressのインスタンスを作成する。
`static CellPosition`	`of(Point point)` CellAddressのインスタンスを作成する。
`static CellPosition`	`of(String address)` CellAddressのインスタンスを作成する。
`org.apache.poi.ss.util.CellAddress`	`toCellAddress()` POIの`CellAddress`の形式に変換します。
`Point`	`toPoint()` `Point`の形式に変換します。
`String`	`toString()` `formatAsString()`の値を返します。

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

- フィールドの詳細
  - A1
```
public static final CellPosition A1
```
    シート上の先頭の位置を表現するための定数。
- メソッドの詳細
  - of
```
public static CellPosition of(int row,
                              int column)
```
    CellAddressのインスタンスを作成する。
    
    パラメータ:
    
    row - 行番号 (0から始まる)
    
    column - 列番号 (0から始まる)
    
    戻り値:
    
    CellPositionのインスタンス
    
    例外:
    
    IllegalArgumentException - row < 0 || column < 0
  - of
```
public static CellPosition of(org.apache.poi.ss.usermodel.Cell cell)
```
    CellAddressのインスタンスを作成する。
    
    パラメータ:
    
    cell - セルのインスタンス。
    
    戻り値:
    
    CellPositionのインスタンス
    
    例外:
    
    IllegalArgumentException - cell == null.
  - of
```
public static CellPosition of(org.apache.poi.ss.util.CellReference reference)
```
    CellAddressのインスタンスを作成する。
    
    パラメータ:
    
    reference - セルの参照形式。
    
    戻り値:
    
    CellPositionのインスタンス
    
    例外:
    
    IllegalArgumentException - reference == null.
  - of
```
public static CellPosition of(org.apache.poi.ss.util.CellAddress address)
```
    CellAddressのインスタンスを作成する。
    
    パラメータ:
    
    address - セルのアドレス
    
    戻り値:
    
    CellPositionのインスタンス
    
    例外:
    
    IllegalArgumentException - address == null.
  - of
```
public static CellPosition of(String address)
```
    CellAddressのインスタンスを作成する。
    
    パラメータ:
    
    address - 'A1'の形式のセルのアドレス
    
    戻り値:
    
    CellPositionのインスタンス
    
    例外:
    
    IllegalArgumentException - address == null || address.length() == 0 || アドレスの書式として不正
  - of
```
public static CellPosition of(Point point)
```
    CellAddressのインスタンスを作成する。
    
    パラメータ:
    
    point - セルの座標
    
    戻り値:
    
    CellPositionのインスタンス
    
    例外:
    
    IllegalArgumentException - point == null.
  - compareTo
```
public int compareTo(CellPosition other)
```
    定義:
    
    compareTo インタフェース内 Comparable<CellPosition>
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 Object
  - equals
```
public boolean equals(Object obj)
```
    オーバーライド:
    
    equals クラス内 Object
  - clone
```
public CellPosition clone()
```
    オーバーライド:
    
    clone クラス内 Object
  - getRow
```
public int getRow()
```
    行番号を取得する。
    
    戻り値:
    
    行番号 (0から始まる)
  - getColumn
```
public int getColumn()
```
    列番号を取得する。
    
    戻り値:
    
    列番号 (0から始まる)
  - toPoint
```
public Point toPoint()
```
    Pointの形式に変換します。
    
    戻り値:
    
    Pointのインスタンス。 x座標が列番号（column index）、y座標が行番号(row index)なります。
  - toCellAddress
```
public org.apache.poi.ss.util.CellAddress toCellAddress()
```
    POIのCellAddressの形式に変換します。
    
    戻り値:
    
    CellAddressのインスタンス。
  - formatAsString
```
public String formatAsString()
```
    セルのアドレスを取得する。
    
    戻り値:
    
    'A1'の形式で、セルノアドレスを文字列として表現する。
  - addRow
```
public CellPosition addRow(int value)
```
    行番号に指定した値を加算する。
    
    パラメータ:
    
    value - 加算する値
    
    戻り値:
    
    加算したインスタンス
  - addColumn
```
public CellPosition addColumn(int value)
```
    列番号に指定した値を加算する。
    
    パラメータ:
    
    value - 加算する値
    
    戻り値:
    
    加算したインスタンス
  - toString
```
public String toString()
```
    formatAsString()の値を返します。
    
    オーバーライド:
    
    toString クラス内 Object

クラス CellPosition

フィールドのサマリー

メソッドのサマリー

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

フィールドの詳細

A1

メソッドの詳細

of

of

of

of

of

of

compareTo

hashCode

equals

clone

getRow

getColumn

toPoint

toCellAddress

formatAsString

addRow

addColumn

toString