|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
java.lang.Objectorg.apache.commons.lang.builder.ToStringStyle
ToStringStyle は ToStringBuilder と共に動作し、toString を生成します。
主な public interface は常に ToStringBuilder を介して処理されます。
ToStringStyle works with ToStringBuilder to create a
toString. The main public interface is always via ToStringBuilder.
このクラスはシングルトンで利用されることを意図されています。
毎回新しいスタイルのインスタンスを生成する必要はありません。
プログラムは一般的にあらかじめ定義された1つの静的なこのクラスを使用することになります。
代わりに StandardToStringStyle クラスを個々の設定に使用することができます。
このクラスの代わりに StandardToStringStyle クラスを使用すれば独自の設定を行うことが可能です。
従ってほとんどのスタイルはサブクラス化を行わなくても実現することができます。
必要であれば、サブクラスは必要なだけメソッドをオーバライドすることが可能でです。 各オブジェクト型 (boolean や long や Object や int[] 等) は自身を出力するためのそれぞれのメソッドを持っています。 その内のほとんどは概要と詳細の2つのバージョンを持っています。 例えば、配列を対象とするメソッドの詳細バージョンは全ての内容を出力し、 概要の方は配列の長さだけ出力します。
| 入れ子クラスの概要 | |
private static class |
ToStringStyle.DefaultToStringStyle
デフォルトの ToStringStyle です。 |
private static class |
ToStringStyle.MultiLineToStringStyle
複数行で内容を表示する ToStringStyle です。 |
private static class |
ToStringStyle.NoFieldNameToStringStyle
フィールド名を表示しない ToStringStyle です。 |
private static class |
ToStringStyle.SimpleToStringStyle
クラス名、ハッシュコード、内容の開始記号、フィールド名を表示しないToStringStyle です。 |
| フィールドの概要 | |
private boolean |
arrayContentDetail
配列の詳細を表示するかどうか(初期値 'true')。 |
private String |
arrayEnd
配列表示の終了記号(初期値 '}')。 |
private String |
arraySeparator
配列の区切り文字(初期値 ',')。 |
private String |
arrayStart
配列表示の開始記号(初期値 '{')。 |
private String |
contentEnd
内容表示の終了記号(初期値 ']')。 |
private String |
contentStart
内容表示の開始記号(初期値 '[')。 |
static ToStringStyle |
DEFAULT_STYLE
デフォルトの toString スタイル。 |
private boolean |
defaultFullDetail
fullDetail が null の場合に使用される値(初期値 'true')。 |
private String |
fieldNameValueSeparator
フィールドの名称と値の区切り文字(初期値 '=')。 |
private String |
fieldSeparator
フィールドの区切り文字(初期値 ',')。 |
static ToStringStyle |
MULTI_LINE_STYLE
複数行表示する toString スタイル。 |
static ToStringStyle |
NO_FIELD_NAMES_STYLE
フィールド名を表示しない toString スタイル。 |
private String |
nullText
null の文字列表現(初期値 '<null>')。 |
static ToStringStyle |
SIMPLE_STYLE
シンプルな toString スタイル。 |
private String |
sizeEndText
サイズ表示の終了記号(初期値 '>')。 |
private String |
sizeStartText
サイズ表示の開始記号(初期値 '<size')。 |
private String |
summaryObjectEndText
オブジェクト情報の終了記号(初期値 '>')。 |
private String |
summaryObjectStartText
オブジェクト情報の開始記号(初期値 '<')。 |
private boolean |
useClassName
クラス名を使うかどうか(初期値 'true')。 |
private boolean |
useFieldNames
フィールド名を使うかどうか(初期値 'true')。 |
private boolean |
useIdentityHashCode
ハッシュコードを使うかどうか(初期値 'true')。 |
private boolean |
useShortClassName
短縮されたクラス名を使うかどうか(初期値 'false')。 |
| コンストラクタの概要 | |
protected |
ToStringStyle()
コンストラクタ。 |
| メソッドの概要 | |
void |
append(StringBuffer buffer,
String fieldName,
boolean value)
toString に boolean の値を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
boolean[] array,
Boolean fullDetail)
toString に boolean の配列を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
byte value)
toString に byte の値を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
byte[] array,
Boolean fullDetail)
toString に byte の配列を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
char value)
toString に char の値を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
char[] array,
Boolean fullDetail)
toString に char の配列を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
double value)
toString に double の値を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
double[] array,
Boolean fullDetail)
toString に double の配列を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
float value)
toString に float の値を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
float[] array,
Boolean fullDetail)
toString に float の配列を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
int value)
toString に int の値を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
int[] array,
Boolean fullDetail)
toString に int の配列を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
long value)
toString に long の値を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
long[] array,
Boolean fullDetail)
toString に long の配列を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
Object[] array,
Boolean fullDetail)
toString にオブジェクトの配列を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
Object value,
Boolean fullDetail)
toString にオブジェクトから生成された内容を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
short value)
toString に short の値を追加します。 |
void |
append(StringBuffer buffer,
String fieldName,
short[] array,
Boolean fullDetail)
toString に short の配列を追加します。 |
protected void |
appendClassName(StringBuffer buffer,
Object object)
クラス名を追加します。 |
protected void |
appendContentEnd(StringBuffer buffer)
バッファに内容の終了記号を追加します。 |
protected void |
appendContentStart(StringBuffer buffer)
バッファに内容の開始記号を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
boolean value)
toString に boolean の値を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
boolean[] array)
toString に boolean の配列の詳細を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
byte value)
toString に byte の値を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
byte[] array)
toString に byte の配列の詳細を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
char value)
toString に char の値を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
char[] array)
toString に char の配列の詳細を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
Collection coll)
toString に Collection を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
double value)
toString に double の値を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
double[] array)
toString に double の配列の詳細を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
float value)
toString に float の値を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
float[] array)
toString に float の配列の詳細を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
int value)
toString に int の値を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
int[] array)
toString に int の配列の詳細を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
long value)
toString に long の値を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
long[] array)
toString に long の配列の詳細を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
Map map)
toString に Map を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
Object value)
toString にオブジェクトの全ての詳細情報を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
Object[] array)
toString にオブジェクトの配列の詳細を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
short value)
toString に short の値を追加します。 |
protected void |
appendDetail(StringBuffer buffer,
String fieldName,
short[] array)
toString に short の配列の詳細を追加します。 |
void |
appendEnd(StringBuffer buffer,
Object object)
データの終了指示を追加します。 |
protected void |
appendFieldEnd(StringBuffer buffer,
String fieldName)
バッファにフィールドの終了を追加します。 |
protected void |
appendFieldSeparator(StringBuffer buffer)
バッファにフィールドの区切り文字を追加します。 |
protected void |
appendFieldStart(StringBuffer buffer,
String fieldName)
バッファにフィールドの開始を追加します。 |
protected void |
appendIdentityHashCode(StringBuffer buffer,
Object object)
ハッシュコードを追加します。 |
protected void |
appendInternal(StringBuffer buffer,
String fieldName,
Object value,
boolean detail)
toString にオブジェクトの情報をその型を判断して追加します。 |
protected void |
appendNullText(StringBuffer buffer,
String fieldName)
バッファに null を示す記号を追加します。 |
void |
appendStart(StringBuffer buffer,
Object object)
データの開始指示を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
boolean[] array)
toString に boolean の配列の概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
byte[] array)
toString に byte の配列の概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
char[] array)
toString に char の配列の概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
double[] array)
toString に double の配列の概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
float[] array)
toString に float の配列の概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
int[] array)
toString に int の配列の概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
long[] array)
toString に long の配列の概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
Object value)
toString にオブジェクトの概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
Object[] array)
toString にオブジェクトの配列の概要を追加します。 |
protected void |
appendSummary(StringBuffer buffer,
String fieldName,
short[] array)
toString に short の配列の概要を追加します。 |
protected void |
appendSummarySize(StringBuffer buffer,
String fieldName,
int size)
toString にサイズの概要を追加します。 |
protected String |
getArrayEnd()
配列の終了を示すテキストを取得します。 |
protected String |
getArraySeparator()
配列の区切り文字を取得します。 |
protected String |
getArrayStart()
配列の開始を示すテキストを取得します。 |
protected String |
getContentEnd()
内容の終了を示すテキストを取得します。 |
protected String |
getContentStart()
内容の開始を示すテキストを取得します。 |
protected String |
getFieldNameValueSeparator()
フィールドの名前と値の区切り文字を取得します。 |
protected String |
getFieldSeparator()
フィールドの区切り文字を取得します。 |
protected String |
getNullText()
null が見つかった場合に出力されるテキストを取得します。 |
protected String |
getShortClassName(Class cls)
クラスの短縮名を取得します。 |
protected String |
getSizeEndText()
Collection、Map または Array のサイズを出力する際のテキストを取得します。 |
protected String |
getSizeStartText()
Collection、Map または Array のサイズを出力する際のテキストを取得します。 |
protected String |
getSummaryObjectEndText()
オブジェクトの概要を出力する際のテキストを取得します。 |
protected String |
getSummaryObjectStartText()
オブジェクトの概要を出力する際のテキストを取得します。 |
protected boolean |
isArrayContentDetail()
配列の詳細な内容を出力するかどうかを取得します。 |
protected boolean |
isDefaultFullDetail()
明示されなかった場合に詳細情報を(デフォルトで)出力するかどうかを取得します。 |
protected boolean |
isFullDetail(Boolean fullDetailRequest)
この(クラスの)フィールドの詳細を出力するかどうかをチェックします。 |
protected boolean |
isShortClassName()
クラスの短縮名を使用するかフルネームを使用するかを取得します。 |
protected boolean |
isUseClassName()
クラス名を使用するかどうかを取得します。 |
protected boolean |
isUseFieldNames()
入力されたフィールド名を使用するかどうかを取得します。 |
protected boolean |
isUseIdentityHashCode()
ハッシュコードを使用するかどうかを取得します。 |
protected void |
setArrayContentDetail(boolean arrayContentDetail)
配列の詳細な内容を出力するかどうかを設定します。 |
protected void |
setArrayEnd(String arrayEnd)
配列の終了を示すテキストを設定します。 |
protected void |
setArraySeparator(String arraySeparator)
配列の区切り文字を設定します。 |
protected void |
setArrayStart(String arrayStart)
配列の開始を示すテキストを設定します。 |
protected void |
setContentEnd(String contentEnd)
内容の終了を示すテキストを設定します。 |
protected void |
setContentStart(String contentStart)
内容の開始を示すテキストを設定します。 |
protected void |
setDefaultFullDetail(boolean defaultFullDetail)
明示されなかった場合に詳細情報を(デフォルトで)出力するかどうかを設定します。 |
protected void |
setFieldNameValueSeparator(String fieldNameValueSeparator)
フィールドの名前と値の区切り文字を設定します。 |
protected void |
setFieldSeparator(String fieldSeparator)
フィールドの区切り文字を設定します。 |
protected void |
setNullText(String nullText)
null が見つかった場合に出力されるテキストを設定します。 |
protected void |
setShortClassName(boolean shortClassName)
クラスの短縮名を使用するかフルネームを使用するかを設定します。 |
protected void |
setSizeEndText(String sizeEndText)
Collection、Map または Array のサイズを出力する際のテキストを設定します。 |
protected void |
setSizeStartText(String sizeStartText)
Collection、Map または Array のサイズを出力する際のテキストを設定します。 |
protected void |
setSummaryObjectEndText(String summaryObjectEndText)
オブジェクトの概要を出力する際のテキストを設定します。 |
protected void |
setSummaryObjectStartText(String summaryObjectStartText)
オブジェクトの概要を出力する際のテキストを設定します。 |
protected void |
setUseClassName(boolean useClassName)
クラス名を使用するかどうかを設定します。 |
protected void |
setUseFieldNames(boolean useFieldNames)
入力されたフィールド名を使用するかどうかを設定します。 |
protected void |
setUseIdentityHashCode(boolean useIdentityHashCode)
ハッシュコードを使用するかどうかを設定します。 |
| クラス java.lang.Object から継承したメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| フィールドの詳細 |
public static final ToStringStyle DEFAULT_STYLE
public static final ToStringStyle MULTI_LINE_STYLE
public static final ToStringStyle NO_FIELD_NAMES_STYLE
public static final ToStringStyle SIMPLE_STYLE
private boolean useFieldNames
private boolean useClassName
private boolean useShortClassName
private boolean useIdentityHashCode
private String contentStart
private String contentEnd
private String fieldNameValueSeparator
private String fieldSeparator
private String arrayStart
private String arraySeparator
private boolean arrayContentDetail
private String arrayEnd
private boolean defaultFullDetail
private String nullText
private String sizeStartText
private String sizeEndText
private String summaryObjectStartText
private String summaryObjectEndText
| コンストラクタの詳細 |
protected ToStringStyle()
| メソッドの詳細 |
public void appendStart(StringBuffer buffer,
Object object)
buffer - 出力先となる StringBuffer
object - toString を生成する際に対象となるオブジェクト、null でない必要があります。
public void appendEnd(StringBuffer buffer,
Object object)
buffer - 出力先となる StringBuffer
object - toString を生成する際に対象となるオブジェクト、null でない必要があります。
public void append(StringBuffer buffer,
String fieldName,
Object value,
Boolean fullDetail)
buffer - 出力先となる StringBuffer
fieldName - フィールド名
value - toString に追加する値
fullDetail - true なら詳細情報、 false なら概要、 null ならスタイルの設定に依存
protected void appendInternal(StringBuffer buffer,
String fieldName,
Object value,
boolean detail)
このメソッドはクラス型が配列、コレクション、マップ、オブジェクトの順に該当するメソッドを 指定された詳細または概要のレベルで判断し、使用します。
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する( null でない)値
detail - 詳細を表示するかどうか
protected void appendDetail(StringBuffer buffer,
String fieldName,
Object value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する( null でない)値
protected void appendDetail(StringBuffer buffer,
String fieldName,
Collection coll)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
coll - toString に追加する( null でない)コレクション
protected void appendDetail(StringBuffer buffer,
String fieldName,
Map map)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
map - toString に追加する( null でない)マップ
protected void appendSummary(StringBuffer buffer,
String fieldName,
Object value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する( null でない)値
public void append(StringBuffer buffer,
String fieldName,
long value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名
value - toString に追加する値
protected void appendDetail(StringBuffer buffer,
String fieldName,
long value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する値
public void append(StringBuffer buffer,
String fieldName,
int value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名
value - toString に追加する値
protected void appendDetail(StringBuffer buffer,
String fieldName,
int value)
buffer - the StringBuffer to populatefieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する値
public void append(StringBuffer buffer,
String fieldName,
short value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名
value - toString に追加する値
protected void appendDetail(StringBuffer buffer,
String fieldName,
short value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する値
public void append(StringBuffer buffer,
String fieldName,
byte value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名
value - toString に追加する値
protected void appendDetail(StringBuffer buffer,
String fieldName,
byte value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する値
public void append(StringBuffer buffer,
String fieldName,
char value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名
value - toString に追加する値
protected void appendDetail(StringBuffer buffer,
String fieldName,
char value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する値
public void append(StringBuffer buffer,
String fieldName,
double value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名
value - toString に追加する値
protected void appendDetail(StringBuffer buffer,
String fieldName,
double value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する値
public void append(StringBuffer buffer,
String fieldName,
float value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名
value - toString に追加する値
protected void appendDetail(StringBuffer buffer,
String fieldName,
float value)
buffer - 出力先となる StringBuffer
fieldName - フィールド名、既に追加されている場合には使用されません
value - toString に追加する値
public void append(StringBuffer buffer,
String fieldName,
boolean value)