org.seasar.util.beans.util
クラス CopyOptionsUtil

java.lang.Object
  org.seasar.util.beans.util.CopyOptionsUtil

public abstract class CopyOptionsUtil
extends Object

CopyOptionsのインスタンス化を容易にするためにstatic importして使うためのユーティリティです。

 import static org.seasar.util.beans.util.CopyOptionsUtil.*;
 
 copyBeanToBean(srcBean, destBean, excludeNull());
 

CopyOptionsUtilの戻り値はCopyOptions なので、メソッドチェーンでオプションを複数指定することもできます。

 copyBeanToBean(srcBean, destBean, excludeNull().dateConverter("date", "MM/dd"));
 

作成者:

koichik

コンストラクタの概要

CopyOptionsUtil()

メソッドの概要

static CopyOptions	beanDelimiter(char beanDelimiter) JavaBeansのデリミタを設定したCopyOptionsを返します。
static CopyOptions	converter(Converter converter, CharSequence... propertyNames) コンバータを設定したCopyOptionsを返します。
static CopyOptions	dateConverter(String pattern, CharSequence... propertyNames) 日付のコンバータを設定したCopyOptionsを返します。
static CopyOptions	exclude(CharSequence... propertyNames) 操作の対象に含めないプロパティ名を指定したCopyOptionsを返します。
static CopyOptions	excludeNull() null値のプロパティを操作の対象外にしたCopyOptionsを返します。
static CopyOptions	excludeWhitespace() 空白のプロパティを操作の対象外にしたCopyOptionsを返します。
static CopyOptions	include(CharSequence... propertyNames) 操作の対象に含めるプロパティ名を指定したCopyOptionsを返します。
static CopyOptions	mapDelimiter(char mapDelimiter) Mapのデリミタを設定したCopyOptionsを返します。
static CopyOptions	numberConverter(String pattern, CharSequence... propertyNames) 数値のコンバータを設定したCopyOptionsを返します。
static CopyOptions	prefix(CharSequence prefix) プレフィックスを指定したCopyOptionsを返します。
static CopyOptions	sqlDateConverter(String pattern, CharSequence... propertyNames) SQL用日付のコンバータを設定したCopyOptionsを返します。
static CopyOptions	timeConverter(String pattern, CharSequence... propertyNames) 時間のコンバータを設定したCopyOptionsを返します。
static CopyOptions	timestampConverter(String pattern, CharSequence... propertyNames) 日時のコンバータを設定したCopyOptionsを返します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

CopyOptionsUtil

public CopyOptionsUtil()

メソッドの詳細

include

public static CopyOptions include(CharSequence... propertyNames)

操作の対象に含めるプロパティ名を指定したCopyOptionsを返します。

パラメータ:

propertyNames - プロパティ名の配列。nullや空配列であってはいけません

戻り値:

操作の対象に含めるプロパティ名を指定したCopyOptions

関連項目:

CopyOptions.include(CharSequence...)

exclude

public static CopyOptions exclude(CharSequence... propertyNames)

操作の対象に含めないプロパティ名を指定したCopyOptionsを返します。

パラメータ:

propertyNames - プロパティ名の配列。nullや空配列であってはいけません

戻り値:

操作の対象に含めないプロパティ名を指定したCopyOptions

関連項目:

CopyOptions.exclude(CharSequence...)

excludeNull

public static CopyOptions excludeNull()

null値のプロパティを操作の対象外にしたCopyOptionsを返します。

戻り値:

null値のプロパティを操作の対象外にしたCopyOptionsを返します。

関連項目:

CopyOptions.excludeNull()

excludeWhitespace

public static CopyOptions excludeWhitespace()

空白のプロパティを操作の対象外にしたCopyOptionsを返します。

戻り値:

空白のプロパティを操作の対象外にしたCopyOptions

関連項目:

CopyOptions.excludeWhitespace()

prefix

public static CopyOptions prefix(CharSequence prefix)

プレフィックスを指定したCopyOptionsを返します。

プレフィックスを指定すると、コピー元のプロパティ名がプレフィックスで始まるプロパティだけがコピーの対象となります。 また、コピー元のプロパティ名からプレフィックスを除去した名前がコピー先のプロパティ名となります。

パラメータ:

prefix - プレフィックス。nullや空文字列であってはいけません

戻り値:

プレフィックスを指定したCopyOptions

関連項目:

CopyOptions.prefix(CharSequence)

beanDelimiter

public static CopyOptions beanDelimiter(char beanDelimiter)

JavaBeansのデリミタを設定したCopyOptionsを返します。

JavaBeansからMapへ、あるいはその逆にコピーする際に、プロパティ名のデリミタを変更することが出来ます。 例えばJavaBeans側のデリミタにアンダースコア、Map側のデリミタにピリオドを指定した場合、 コピー元とコピー先のプリパティ名は次のようになります。

JavaBeansのプロパティ名	Mapのプロパティ名
foo	foo
foo_bar	foo.bar
foo_bar_baz	foo.bar.baz

パラメータ:

beanDelimiter - JavaBeansのデリミタ

戻り値:

JavaBeansのデリミタを設定したCopyOptions

関連項目:

CopyOptions.beanDelimiter(char)

mapDelimiter

public static CopyOptions mapDelimiter(char mapDelimiter)

Mapのデリミタを設定したCopyOptionsを返します。

JavaBeansからMapへ、あるいはその逆にコピーする際に、プロパティ名のデリミタを変更することが出来ます。 例えばJavaBeans側のデリミタにアンダースコア、Map側のデリミタにピリオドを指定した場合、 コピー元とコピー先のプリパティ名は次のようになります。

JavaBeansのプロパティ名	Mapのプロパティ名
foo	foo
foo_bar	foo.bar
foo_bar_baz	foo.bar.baz

パラメータ:

mapDelimiter - Mapのデリミタ

戻り値:

Mapのデリミタを設定したCopyOptions

関連項目:

CopyOptions.mapDelimiter(char)

converter

public static CopyOptions converter(Converter converter,
                                    CharSequence... propertyNames)

コンバータを設定したCopyOptionsを返します。

パラメータ:

converter - コンバータ。nullであってはいけません

propertyNames - このコンバータを適用するプロパティ名の並び。各要素はnullや空文字列であってはいけません

戻り値:

コンバータを設定したCopyOptions

関連項目:

CopyOptions.converter(Converter, CharSequence...)

dateConverter

public static CopyOptions dateConverter(String pattern,
                                        CharSequence... propertyNames)

日付のコンバータを設定したCopyOptionsを返します。

パラメータ:

pattern - 日付のパターン。nullや空文字列であってはいけません

propertyNames - プロパティ名の配列。各要素はnullや空文字列であってはいけません

戻り値:

日付のコンバータを設定したCopyOptions

関連項目:

CopyOptions.dateConverter(String, CharSequence...), DateConverter

sqlDateConverter

public static CopyOptions sqlDateConverter(String pattern,
                                           CharSequence... propertyNames)

SQL用日付のコンバータを設定したCopyOptionsを返します。

パラメータ:

pattern - 日付のパターン。nullや空文字列であってはいけません

propertyNames - プロパティ名の配列。各要素はnullや空文字列であってはいけません

戻り値:

SQL用日付のコンバータを設定したCopyOptions

関連項目:

CopyOptions.sqlDateConverter(String, CharSequence...), SqlDateConverter

timeConverter

public static CopyOptions timeConverter(String pattern,
                                        CharSequence... propertyNames)

時間のコンバータを設定したCopyOptionsを返します。

パラメータ:

pattern - 時間のパターン。nullや空文字列であってはいけません

propertyNames - プロパティ名の配列。各要素はnullや空文字列であってはいけません

戻り値:

時間のコンバータを設定したCopyOptions

関連項目:

CopyOptions.timeConverter(String, CharSequence...), TimeConverter

timestampConverter

public static CopyOptions timestampConverter(String pattern,
                                             CharSequence... propertyNames)

日時のコンバータを設定したCopyOptionsを返します。

パラメータ:

pattern - 日時のパターン。nullや空文字列であってはいけません

propertyNames - プロパティ名の配列。各要素はnullや空文字列であってはいけません

戻り値:

日時のコンバータを設定したCopyOptions

関連項目:

CopyOptions.timestampConverter(String, CharSequence...), TimestampConverter

numberConverter

public static CopyOptions numberConverter(String pattern,
                                          CharSequence... propertyNames)

数値のコンバータを設定したCopyOptionsを返します。

パラメータ:

pattern - 数値のパターン。nullや空文字列であってはいけません

propertyNames - プロパティ名の配列。各要素はnullや空文字列であってはいけません

戻り値:

数値のコンバータを設定したCopyOptions

関連項目:

CopyOptions.numberConverter(String, CharSequence...), NumberConverter