BeanUtil (Nablarch-API)

java.lang.Object
- nablarch.core.beans.BeanUtil

```
@Published
public final class BeanUtil
extends java.lang.Object
```
JavaBeansに関する操作をまとめたユーティリティクラス。

メソッドのサマリー

すべてのメソッド staticメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static <SRC,DEST> DEST`	`copy(SRC srcBean, DEST destBean)` BeanからBeanに値をコピーする。
`static <SRC,DEST> DEST`	`copyExcludes(SRC srcBean, DEST destBean, java.lang.String... excludes)` BeanからBeanに、指定されたプロパティ以外をコピーする。
`static <SRC,DEST> DEST`	`copyExcludesNull(SRC srcBean, DEST destBean)` BeanからBeanに値をコピーする。
`static <SRC,DEST> DEST`	`copyIncludes(SRC srcBean, DEST destBean, java.lang.String... includes)` BeanからBeanに、指定されたプロパティをコピーする。
`protected static <SRC,DEST> DEST`	`copyInner(SRC srcBean, DEST destBean, boolean excludesNull, java.lang.String... excludesProperties)` BeanからBeanに値をコピーする。
`static <T> T`	`createAndCopy(java.lang.Class<T> beanClass, java.util.Map<java.lang.String,?> map)` `Map`からBeanを生成する。
`static <T> T`	`createAndCopy(java.lang.Class<T> beanClass, java.lang.Object srcBean)` Java Beansからプロパティをコピーして、別のBeanを作成する。
`static <T> T`	`createAndCopyExcludes(java.lang.Class<T> beanClass, java.util.Map<java.lang.String,?> map, java.lang.String... excludes)` `Map`から指定されたプロパティ以外をコピーしてBeanを生成する。
`static <T> T`	`createAndCopyExcludes(java.lang.Class<T> beanClass, java.lang.Object srcBean, java.lang.String... excludes)` Java Beansから指定されたプロパティ以外をコピーして、別のBeanを作成する。
`static <T> T`	`createAndCopyIncludes(java.lang.Class<T> beanClass, java.util.Map<java.lang.String,?> map, java.lang.String... includes)` `Map`から、指定したプロパティのみをコピーしたBeanを生成する。
`static <T> T`	`createAndCopyIncludes(java.lang.Class<T> beanClass, java.lang.Object srcBean, java.lang.String... includes)` Java Beansから指定されたプロパティをコピーして、別のBeanを作成する。
`static <SRC> java.util.Map<java.lang.String,java.lang.Object>`	`createMapAndCopy(SRC srcBean)` BeanからMapにプロパティの値をコピーする。
`static <SRC> java.util.Map<java.lang.String,java.lang.Object>`	`createMapAndCopyExcludes(SRC srcBean, java.lang.String... excludeProperties)` BeanからMapにプロパティの値をコピーする。
`static <SRC> java.util.Map<java.lang.String,java.lang.Object>`	`createMapAndCopyIncludes(SRC srcBean, java.lang.String... includesProperties)` BeanからMapに指定されたプロパティの値をコピーする。
`static java.lang.Object`	`getProperty(java.lang.Object bean, java.lang.String propertyName)` 指定したオブジェクトから、特定のプロパティの値を取得する。
`static java.lang.Object`	`getProperty(java.lang.Object bean, java.lang.String propertyName, java.lang.Class<?> type)` 指定したオブジェクトのプロパティの値を、指定した型に変換して取得する。
`static java.beans.PropertyDescriptor`	`getPropertyDescriptor(java.lang.Class<?> beanClass, java.lang.String propertyName)` 指定したクラスから、特定のプロパティの`PropertyDescriptor` を取得する。
`static java.beans.PropertyDescriptor[]`	`getPropertyDescriptors(java.lang.Class<?> beanClass)` 指定したクラスに属する全てのプロパティの `PropertyDescriptor` を取得する。
`static void`	`setProperty(java.lang.Object bean, java.lang.String propertyName, java.lang.Object propertyValue)` 指定したオブジェクトのプロパティに値を登録する。

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

- メソッドの詳細
  - getPropertyDescriptors
```
public static java.beans.PropertyDescriptor[] getPropertyDescriptors(java.lang.Class<?> beanClass)
```
    指定したクラスに属する全てのプロパティの PropertyDescriptor を取得する。ただし、classプロパティは取得対象外となる。
    
    パラメータ:
    
    beanClass - プロパティを取得したいクラス
    
    戻り値:
    
    PropertyDescriptor[] 全てのプロパティの PropertyDescriptor
    
    例外:
    
    BeansException - プロパティの取得に失敗した場合。
  - getPropertyDescriptor
```
public static java.beans.PropertyDescriptor getPropertyDescriptor(java.lang.Class<?> beanClass,
                                                                  java.lang.String propertyName)
```
    指定したクラスから、特定のプロパティのPropertyDescriptor を取得する。
    
    パラメータ:
    
    beanClass - プロパティを取得したいクラス
    
    propertyName - 取得したいプロパティ名
    
    戻り値:
    
    PropertyDescriptor 取得したプロパティ
    
    例外:
    
    BeansException - propertyName に対応するプロパティが定義されていない場合。
  - getProperty
```
public static java.lang.Object getProperty(java.lang.Object bean,
                                           java.lang.String propertyName)
```
    指定したオブジェクトから、特定のプロパティの値を取得する。
    propertyNameには、beanのトップレベル要素のみ指定可能である。
```
     
     // ----------サンプルで使用するBean----------
     public class SampleBean {
         private String stringProp;
         private List<String> listProp;
         private String[] arrayProp;
         private NestedBean nestedBean;
         // setter及びgetterは省略
     }

     public class NestedBean {
         private String nestedStringProp;
         // setter及びgetterは省略
     }

     // ----------実装例----------
     // 問題のないコード1
     String stringProp = BeanUtil.getProperty(sampleBean, "stringProp");

     // 問題のないコード2
     String stringProp = BeanUtil.getProperty(sampleBean.nestedBean, "nestedStringProp");

     // 以下のコードは動作しない
     String nestedStringProp = BeanUtil.getProperty(sampleBean, "nestedBean.nestedStringProp");

     
 
```
    パラメータ:
    
    bean - プロパティの値を取得したいBeanオブジェクト
    
    propertyName - 取得したいプロパティ名
    
    戻り値:
    
    Object オブジェクトから取得したプロパティの値
    
    例外:
    
    BeansException - propertyName に対応するプロパティが定義されていない場合。
  - getProperty
```
public static java.lang.Object getProperty(java.lang.Object bean,
                                           java.lang.String propertyName,
                                           java.lang.Class<?> type)
```
    指定したオブジェクトのプロパティの値を、指定した型に変換して取得する。
    型変換の仕様はConversionUtilを参照。
    propertyNameの指定方法についてはgetProperty(Object, String)を参照。
    
    パラメータ:
    
    bean - プロパティの値を取得したいBeanオブジェクト
    
    propertyName - 取得したいプロパティの名称
    
    type - 変換したい型 (nullを指定した場合は変換を行わず、プロパティの値をそのまま返す。)
    
    戻り値:
    
    Object 取得したプロパティをtypeに変換したオブジェクト
    
    例外:
    
    BeansException - propertyName に対応するプロパティが定義されていない場合。
  - setProperty
```
public static void setProperty(java.lang.Object bean,
                               java.lang.String propertyName,
                               java.lang.Object propertyValue)
```
    指定したオブジェクトのプロパティに値を登録する。
    対象のプロパティにsetterが定義されていない場合はなにもしない。
    propertyValueがnullの場合は、例外の送出やログ出力は行わずに、対象プロパティの値はnullになる。
    プロパティの指定方法
    propertyNameにはプロパティ名を指定する。 List型・配列型のプロパティでは、"プロパティ名[インデックス]"という形式で要素番号を指定して値を登録できる。ネストしたプロパティを指定することも可能である。ネストの深さに制限はない。ネストの親となるプロパティがnullである場合は、デフォルトコンストラクタを起動しインスタンスを生成してから値を格納する。実装例
```
 
     // ----------サンプルで使用するBean----------
     public class SampleBean {
         private String stringProp;
         private List<String> listProp;
         private String[] arrayProp;
         private NestedBean nestedBean;
         // setter及びgetterは省略
     }
     public class NestedBean {
         private String nestedStringProp;

         // setter及びgetterは省略
     }

     // ----------実装例----------
     SampleBean sampleBean = new SampleBean();

     // stringPropプロパティに"value"を登録
     BeanUtil.setProperty(sampleBean,"stringProp", "value");

     // stringPropプロパティにnullを登録。stringPropはnullとなる
     BeanUtil.setProperty(sampleBean,"stringProp", null);

     // listPropPropプロパティの要素番号0の位置に"list_value"を登録
     BeanUtil.setProperty(sampleBean,"listProp[0]", "list_value");

     // 配列型のプロパティの要素番号0の位置に"array_value"を登録
     // 十分な要素数が自動で確保される
     BeanUtil.setProperty(sampleBean, "arrayProp[0]", "array_value");

     // nestedBeanプロパティのnestedStringPropプロパティに"nested_value"を登録
     BeanUtil.setProperty(sampleBean, "nestedBean.nestedStringProp", "nested_value");
 
 
```
    パラメータ:
    
    bean - 値を登録したいBeanオブジェクト
    
    propertyName - 値を登録したいプロパティ名
    
    propertyValue - 登録したい値
    
    例外:
    BeansException -
    
    propertyNameに対応するプロパティが定義されていない場合
    
    List型・配列型以外のプロパティに、"プロパティ名[インデックス]"という形式で指定した場合
    
    ネストの親となるプロパティのインスタンス生成に失敗した場合
  - createAndCopy
```
public static <T> T createAndCopy(java.lang.Class<T> beanClass,
                                  java.util.Map<java.lang.String,?> map)
```
    MapからBeanを生成する。
    mapがnullである場合は、デフォルトコンストラクタでbeanClassを生成して返却する。
    mapにvalueがnullのエントリがある場合、対応するプロパティの値はnullとなる。
    対象のプロパティにsetterが定義されていない場合はなにもしない。
    プロパティの指定方法
    mapに格納するエントリのキー値には、値を登録したいプロパティ名を指定する。 List型・配列型のプロパティでは、"プロパティ名[インデックス]"という形式で要素番号を指定して値を登録できる。ネストしたプロパティを指定することも可能である。ネストの深さに制限はない。ネストの親となるプロパティがnullである場合は、インスタンスを生成してから値を登録する。実装例
```
 
     // ----------サンプルで使用するBean----------
     public class SampleBean {
         private String stringProp;
         private List<String> listProp;
         private String[] arrayProp;
         private NestedBean nestedBean;

         // setter及びgetterは省略
     }

     public class NestedBean {
         private String nestedStringProp;

         // setter及びgetterは省略
     }

     // ----------実装例----------
     // 格納したいプロパティ名をkeyに、値をvalueにもつMapを作成する
     Map<String,Object> map = new HashMap();

     // String型のプロパティに"value"を登録
     map.put("stringProp", "value");

     // stringPropプロパティにnullを登録。stringPropはnullとなる。
     map.put("stringProp", null);

     // List型のプロパティの要素番号0の位置に"list_value"を登録
     map.put("listProp[0]", "list_value");

     // 配列型のプロパティの要素番号0の位置に"array_value"を登録
     // 十分な要素数が自動で確保される
     map.put("arrayProp[0]", "array_value");

     // ネストしたオブジェクトのプロパティに"nested_value"を登録
     map.put("nestedBean.nestedStringProp", "nested_value");

     SampleBean sampleBean = BeanUtil.createAndCopy(SampleBean.class,map);
 
 
```
    型パラメータ:
    
    T - 型引数
    
    パラメータ:
    
    beanClass - 生成したいBeanクラス
    
    map - JavaBeansのプロパティ名をエントリーのキープロパティの値をエントリーの値とするMap
    
    戻り値:
    
    プロパティに値が登録されたBeanオブジェクト
    
    例外:
    
    BeansException - beanClassにデフォルトコンストラクタが定義されていない場合や、 beanClassのコンストラクタ実行時に問題が発生した場合。
  - createAndCopyIncludes
```
public static <T> T createAndCopyIncludes(java.lang.Class<T> beanClass,
                                          java.util.Map<java.lang.String,?> map,
                                          java.lang.String... includes)
```
    Mapから、指定したプロパティのみをコピーしたBeanを生成する。
    mapがnullである場合は、デフォルトコンストラクタでbeanClassを生成して返却する。
    mapでvalueがnullであるプロパティの値はnullになる。例外の送出やログ出力は行わない。
    対象のプロパティにsetterが定義されていない場合はなにもしない。
    プロパティの指定方法についてはcreateAndCopy(Class, Map)を参照。
    
    型パラメータ:
    
    T - 型引数
    
    パラメータ:
    
    beanClass - 生成したいBeanクラス
    
    map - JavaBeansのプロパティ名をエントリーのキープロパティの値をエントリーの値とするMap
    
    includes - コピー対象のプロパティ名
    
    戻り値:
    
    Beanオブジェクト
    
    例外:
    
    BeansException - beanClassにデフォルトコンストラクタが定義されていない場合や、 beanClassのコンストラクタ実行時に問題が発生した場合。
  - createAndCopyExcludes
```
public static <T> T createAndCopyExcludes(java.lang.Class<T> beanClass,
                                          java.util.Map<java.lang.String,?> map,
                                          java.lang.String... excludes)
```
    Mapから指定されたプロパティ以外をコピーしてBeanを生成する。
    mapがnullである場合は、デフォルトコンストラクタでbeanClassを生成して返却する。
    mapでvalueがnullであるプロパティの値はnullになる。例外の送出やログ出力は行わない。
    対象のプロパティにsetterが定義されていない場合はなにもしない。
    プロパティの指定方法についてはcreateAndCopy(Class, Map)を参照。
    
    型パラメータ:
    
    T - 型引数
    
    パラメータ:
    
    beanClass - 生成したいBeanクラス
    
    map - JavaBeansのプロパティ名をエントリーのキープロパティの値をエントリーの値とするMap
    
    excludes - コピー対象外のプロパティ名
    
    戻り値:
    
    プロパティに値が登録されたBeanオブジェクト
    
    例外:
    
    BeansException - beanClassにデフォルトコンストラクタが定義されていない場合や、 beanClassのコンストラクタ実行時に問題が発生した場合。
  - createAndCopy
```
public static <T> T createAndCopy(java.lang.Class<T> beanClass,
                                  java.lang.Object srcBean)
```
    Java Beansからプロパティをコピーして、別のBeanを作成する。
    srcBeanがnullである場合、デフォルトコンストラクタでbeanClassを生成して返却する。
    
    型パラメータ:
    
    T - 型引数
    
    パラメータ:
    
    beanClass - コピー先のBeanクラス
    
    srcBean - コピー元のBean
    
    戻り値:
    
    コピーされたBeanオブジェクト
    
    例外:
    
    BeansException - beanClassにデフォルトコンストラクタが定義されていない場合や、 beanClassのコンストラクタの実行中に問題が発生した場合。
  - createAndCopyIncludes
```
public static <T> T createAndCopyIncludes(java.lang.Class<T> beanClass,
                                          java.lang.Object srcBean,
                                          java.lang.String... includes)
```
    Java Beansから指定されたプロパティをコピーして、別のBeanを作成する。
    srcBeanがnullである場合、デフォルトコンストラクタでbeanClassを生成して返却する。
    
    型パラメータ:
    
    T - 型引数
    
    パラメータ:
    
    beanClass - コピー先のBeanクラス
    
    srcBean - コピー元のBean
    
    includes - コピー対象のプロパティ名
    
    戻り値:
    
    コピーされたBeanオブジェクト
    
    例外:
    
    BeansException - beanClassにデフォルトコンストラクタが定義されていない場合や、 beanClassのデフォルトコンストラクタの実行中に問題が発生した場合。
  - createAndCopyExcludes
```
public static <T> T createAndCopyExcludes(java.lang.Class<T> beanClass,
                                          java.lang.Object srcBean,
                                          java.lang.String... excludes)
```
    Java Beansから指定されたプロパティ以外をコピーして、別のBeanを作成する。
    srcBeanがnullである場合、デフォルトコンストラクタでbeanClassを生成して返却する。
    プロパティのコピーはsrcBeanに定義されたプロパティをベースに実行される。 srcBeanに存在し、beanClassに存在しないプロパティはコピーされない。
    
    型パラメータ:
    
    T - 型引数
    
    パラメータ:
    
    beanClass - コピー先のBeanクラス
    
    srcBean - コピー元のBean
    
    excludes - コピー対象外のプロパティ名
    
    戻り値:
    
    プロパティに値がコピーされたBeanオブジェクト
    
    例外:
    
    BeansException - beanClassのデフォルトコンストラクタの実行中に問題が発生した場合や、 beanClassのプロパティのデフォルトコンストラクタの実行中に問題が発生した場合。
  - copyInner
```
protected static <SRC,DEST> DEST copyInner(SRC srcBean,
                                           DEST destBean,
                                           boolean excludesNull,
                                           java.lang.String... excludesProperties)
```
    BeanからBeanに値をコピーする。
    内部で共通的に使用されるメソッド。
    
    型パラメータ:
    
    SRC - コピー元のBeanの型
    
    DEST - コピー先のBeanの型
    
    パラメータ:
    
    srcBean - コピー元のBeanオブジェクト
    
    destBean - コピー先のBeanオブジェクト
    
    excludesNull - nullプロパティを対象外とするか?
    
    excludesProperties - コピー対象外のプロパティ名
    
    戻り値:
    
    コピー先のBeanオブジェクト
  - copy
```
public static <SRC,DEST> DEST copy(SRC srcBean,
                                   DEST destBean)
```
    BeanからBeanに値をコピーする。
    プロパティのコピーはsrcBeanに定義されたプロパティをベースに実行される。 srcBeanに存在し、destBeanに存在しないプロパティはコピーされない。
    
    型パラメータ:
    
    SRC - コピー元のBeanの型
    
    DEST - コピー先のBeanの型
    
    パラメータ:
    
    srcBean - コピー元のBeanオブジェクト
    
    destBean - コピー先のBeanオブジェクト
    
    戻り値:
    
    コピー先のBeanオブジェクト
    
    例外:
    
    BeansException - destBeanのプロパティのインスタンス生成に失敗した場合
  - copyExcludesNull
```
public static <SRC,DEST> DEST copyExcludesNull(SRC srcBean,
                                               DEST destBean)
```
    BeanからBeanに値をコピーする。ただしnullのプロパティはコピーしない。
    プロパティのコピーはsrcBeanに定義されたプロパティをベースに実行される。 srcBeanに存在し、destBeanに存在しないプロパティはコピーされない。
    
    型パラメータ:
    
    SRC - コピー元Beanの型
    
    DEST - コピー先のBeanの型
    
    パラメータ:
    
    srcBean - コピー元のBeanオブジェクト
    
    destBean - コピー先のBeanオブジェクト
    
    戻り値:
    
    コピー先のBeanオブジェクト
    
    例外:
    
    BeansException - destBeanのプロパティのインスタンス生成に失敗した場合
  - copyIncludes
```
public static <SRC,DEST> DEST copyIncludes(SRC srcBean,
                                           DEST destBean,
                                           java.lang.String... includes)
```
    BeanからBeanに、指定されたプロパティをコピーする。
    プロパティのコピーはsrcBeanに定義されたプロパティをベースに実行される。 srcBeanに存在し、destBeanに存在しないプロパティはコピーされない。
    includesには、srcBeanのトップレベル要素のみ指定可能である。それ以外を指定した場合はコピーされない。
```
     
     // aaa.bbbはコピーされない
     SampleBean copiedSampleBean = BeanUtil.createAndCopyIncludes(SampleBean.class, sampleBean, "aaa.bbb");
     
 
```
    型パラメータ:
    
    SRC - コピー元Beanの型
    
    DEST - コピー先のBeanの型
    
    パラメータ:
    
    srcBean - コピー元のBeanオブジェクト
    
    destBean - コピー先のBeanオブジェクト
    
    includes - コピー対象のプロパティ名
    
    戻り値:
    
    コピー先のBeanオブジェクト
    
    例外:
    
    BeansException - destBeanのプロパティのインスタンス生成に失敗した場合
  - copyExcludes
```
public static <SRC,DEST> DEST copyExcludes(SRC srcBean,
                                           DEST destBean,
                                           java.lang.String... excludes)
```
    BeanからBeanに、指定されたプロパティ以外をコピーする。
    プロパティのコピーはsrcBeanに定義されたプロパティをベースに実行される。 srcBeanに存在し、destBeanに存在しないプロパティはコピーされない。
    
    型パラメータ:
    
    SRC - コピー元Beanの型
    
    DEST - コピー先のBeanの型
    
    パラメータ:
    
    srcBean - コピー元のBeanオブジェクト
    
    destBean - コピー先のBeanオブジェクト
    
    excludes - コピー対象外のプロパティ名
    
    戻り値:
    
    コピー先のBeanオブジェクト
    
    例外:
    
    BeansException - destBeanのプロパティのインスタンス生成に失敗した場合
  - createMapAndCopy
```
public static <SRC> java.util.Map<java.lang.String,java.lang.Object> createMapAndCopy(SRC srcBean)
```
    BeanからMapにプロパティの値をコピーする。
    Mapのキーはプロパティ名で、値はプロパティ値となる。値の型変換は行わず、Beanのプロパティの値を単純にMapの値に設定する。 BeanがBeanを持つ構造の場合、Mapのキー値は「.」で連結された値となる。
    
    型パラメータ:
    
    SRC - Beanの型
    
    パラメータ:
    
    srcBean - Bean
    
    戻り値:
    
    BeanのプロパティをコピーしたMap
  - createMapAndCopyExcludes
```
public static <SRC> java.util.Map<java.lang.String,java.lang.Object> createMapAndCopyExcludes(SRC srcBean,
                                                                                              java.lang.String... excludeProperties)
```
    BeanからMapにプロパティの値をコピーする。
    Mapのキーはプロパティ名で、値はプロパティ値となる。値の型変換は行わず、Beanのプロパティの値を単純にMapの値に設定する。 BeanがBeanを持つ構造の場合、Mapのキー値は「.」で連結された値となる。
    除外対象のプロパティ名が指定された場合は、そのプロパティがコピー対象から除外される。
    
    型パラメータ:
    
    SRC - Beanの型
    
    パラメータ:
    
    srcBean - Bean
    
    excludeProperties - 除外対象のプロパティ名
    
    戻り値:
    
    BeanのプロパティをコピーしたMap
  - createMapAndCopyIncludes
```
public static <SRC> java.util.Map<java.lang.String,java.lang.Object> createMapAndCopyIncludes(SRC srcBean,
                                                                                              java.lang.String... includesProperties)
```
    BeanからMapに指定されたプロパティの値をコピーする。
    Mapのキーはプロパティ名で、値はプロパティ値となる。値の型変換は行わず、Beanのプロパティの値を単純にMapの値に設定する。 BeanがBeanを持つ構造の場合、Mapのキー値は「.」で連結された値となる。
    コピー対象のプロパティ名として指定できるのは、トップ階層のBeanのプロパティ名となる。このため、階層構造で子階層のBeanがinclude指定されていた場合、子階層のBeanのプロパティは全てコピーされる。
    
    型パラメータ:
    
    SRC - Beanの型
    
    パラメータ:
    
    srcBean - Bean
    
    includesProperties - コピー対象のプロパティ名のリスト
    
    戻り値:
    
    BeanのプロパティをコピーしたMap

クラス BeanUtil

メソッドのサマリー

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

メソッドの詳細

getPropertyDescriptors

getPropertyDescriptor

getProperty

getProperty

setProperty

createAndCopy

createAndCopyIncludes

createAndCopyExcludes

createAndCopy

createAndCopyIncludes

createAndCopyExcludes

copyInner

copy

copyExcludesNull

copyIncludes

copyExcludes

createMapAndCopy

createMapAndCopyExcludes

createMapAndCopyIncludes