org.seasar.doma.copy
クラス CopyOptions

java.lang.Object
  org.seasar.doma.copy.CopyOptions

public class CopyOptions
extends Object

コピーのオプションです。

デフォルトでは、次の値をコピーしません。

• null
• 空文字

作成者:

taedium

フィールドの概要

protected BeanWrapperFactory	beanWrapperFactory JavaBeans へのアクセスする BeanWrapper のファクトリ
protected Map<String,Converter<?>>	converterMap プロパティ名をキー、コンバーターを値とするマップ
protected static String[]	EMPTY_STRINGS String の空の配列
protected boolean	emptyStringIncluded 空文字列がコピー対象に含まれるかどうか
protected String[]	excludedPropertyNames コピー非対象のプロパティ名の配列
protected String[]	includedPropertyNames コピー対象のプロパティ名の配列
protected boolean	nullIncluded null がコピー対象に含まれるかどうか
protected Map<String,String>	patterns プロパティ名をキー、パターンを値とするマップ
protected boolean	whitespaceIncluded 空白文字列がコピー対象に含まれるかどうか

コンストラクタの概要

CopyOptions()

メソッドの概要

CopyOptions	beanWrapperFactory(BeanWrapperFactory beanWrapperFactory) JavaBeans にどのようにアクセスするかを決める BeanWrapper のファクトリを設定します。
CopyOptions	converter(Converter<?> converter, String... propertyNames) 特定のプロパティに明示的にコンバーターを指定します。
CopyOptions	exclude(String... propertyNames) コピーの非対象とするプロパティ名を設定します。
CopyOptions	excludeWhitespace() 空白文字をコピーの非対象とすることを示します。
BeanWrapperFactory	getBeanFactory() beanWrapperFactory(BeanWrapperFactory) で設定された BeanWrapperFactory の実装を返します。
Converter<?>	getConverter(String propertyName) プロパティ名に対応付けられたコンバーターを返します。
String	getPattern(String propertyName) プロパティ名に対応付けられたパターンを返します。
CopyOptions	include(String... propertyNames) コピーの対象とするプロパティ名を設定します。
CopyOptions	includeEmptyString() 空文字をコピーの対象とすることを示します。
CopyOptions	includeNull() null をコピーの対象とすることを示します。
boolean	isTargetProperty(String propertyName) プロパティがコピーの対象であるかどうかを返します。
boolean	isTargetValue(Object srcValue) コピー元の値がコピーの対象であるかどうかを返します。
CopyOptions	pattern(String pattern, String... propertyNames) 特定のプロパティに明示的にパターンを指定します。

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

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

フィールドの詳細

EMPTY_STRINGS

protected static final String[] EMPTY_STRINGS

String の空の配列

converterMap

protected final Map<String,Converter<?>> converterMap

プロパティ名をキー、コンバーターを値とするマップ

patterns

protected final Map<String,String> patterns

プロパティ名をキー、パターンを値とするマップ

includedPropertyNames

protected String[] includedPropertyNames

コピー対象のプロパティ名の配列

excludedPropertyNames

protected String[] excludedPropertyNames

コピー非対象のプロパティ名の配列

nullIncluded

protected boolean nullIncluded

null がコピー対象に含まれるかどうか

emptyStringIncluded

protected boolean emptyStringIncluded

空文字列がコピー対象に含まれるかどうか

whitespaceIncluded

protected boolean whitespaceIncluded

空白文字列がコピー対象に含まれるかどうか

beanWrapperFactory

protected BeanWrapperFactory beanWrapperFactory

JavaBeans へのアクセスする BeanWrapper のファクトリ

コンストラクタの詳細

CopyOptions

public CopyOptions()

メソッドの詳細

include

public CopyOptions include(String... propertyNames)

コピーの対象とするプロパティ名を設定します。

パラメータ:

propertyNames - プロパティ名の可変長配列

戻り値:

このインスタンス

exclude

public CopyOptions exclude(String... propertyNames)

コピーの非対象とするプロパティ名を設定します。

パラメータ:

propertyNames - プロパティ名の可変長配列

戻り値:

このインスタンス

includeNull

public CopyOptions includeNull()

null をコピーの対象とすることを示します。

戻り値:

このインスタンス

includeEmptyString

public CopyOptions includeEmptyString()

空文字をコピーの対象とすることを示します。

戻り値:

このインスタンス

excludeWhitespace

public CopyOptions excludeWhitespace()

空白文字をコピーの非対象とすることを示します。

戻り値:

このインスタンス

converter

public CopyOptions converter(Converter<?> converter,
                             String... propertyNames)

特定のプロパティに明示的にコンバーターを指定します。

パラメータ:

converter - コンバーターを設定します。

propertyNames - コンバーターを適用するプロパティ名の可変長配列

戻り値:

このインスタンス

pattern

public CopyOptions pattern(String pattern,
                           String... propertyNames)

特定のプロパティに明示的にパターンを指定します。

パターンを表す文字列は、ある型から Stringへ変換される際、また、 String から別の型に変換される際に使用されます。実際にパターンが使用されるかどうかは使用される Converter の実装によります。

パラメータ:

pattern - パターンを表す文字列

propertyNames - パターンを適用するプロパティ名の可変長配列

戻り値:

このインスタンス

beanWrapperFactory

public CopyOptions beanWrapperFactory(BeanWrapperFactory beanWrapperFactory)

JavaBeans にどのようにアクセスするかを決める BeanWrapper のファクトリを設定します。

パラメータ:

beanWrapperFactory - BeanWrapper のファクトリ

戻り値:

このインスタンス

getConverter

public Converter<?> getConverter(String propertyName)

プロパティ名に対応付けられたコンバーターを返します。

パラメータ:

propertyName - プロパティ名

戻り値:

コンバーター、対応するコンバーターが存在しない場合 null

getPattern

public String getPattern(String propertyName)

プロパティ名に対応付けられたパターンを返します。

パラメータ:

propertyName - プロパティ名

戻り値:

パターン、対応するパターンが存在しない場合 null

getBeanFactory

public BeanWrapperFactory getBeanFactory()

beanWrapperFactory(BeanWrapperFactory) で設定された BeanWrapperFactory の実装を返します。

戻り値:

BeanWrapperFactory の実装、存在しない場合 null

isTargetProperty

public boolean isTargetProperty(String propertyName)

プロパティがコピーの対象であるかどうかを返します。

パラメータ:

propertyName - プロパティ名

戻り値:

コピーの対象である場合 true

isTargetValue

public boolean isTargetValue(Object srcValue)

コピー元の値がコピーの対象であるかどうかを返します。

パラメータ:

srcValue - コピー元の値

戻り値:

コピーの対象である場合 true