ObjectUtil (Nablarch-API)

java.lang.Object
- nablarch.core.util.ObjectUtil

```
@Published(tag="architect")
public final class ObjectUtil
extends java.lang.Object
```
フレームワークで使用する、オブジェクトの取り扱いを助けるユーティリティクラス。

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.List<java.lang.Class<? extends java.lang.RuntimeException>>`	`createExceptionsClassList(java.util.List<java.lang.String> originalExceptions)` 例外の名称のリストから例外クラスのリストを生成する。指定されたList<String>の各要素を Class<? extends RuntimeException>に変換し返却する。例外クラスは、`originalExceptions`の文字列クラス名の格納順にリストに格納されて返される。 `originalExceptions`が空の場合は、空のリストを返す。
`static <T> T`	`createInstance(java.lang.String className)` クラス名からインスタンスを生成する。
`static java.lang.reflect.Method`	`findMatchMethod(java.lang.Class<?> objectClass, java.lang.String methodName, java.lang.Class<?>... valueTypes)` 指定したシグネチャにマッチするメソッドを検索する。マッチするメソッドが見つからなかった場合は`null`を返す。マッチング条件は以下である。 `methodName`とメソッド名が一致していること `valueTypes`と引数の数が一致していること `valueTypes`と引数の型が一致していること。ただし、以下の場合は「同一の型」と見なす。プリミティブ型とそのラッパー型とを比較した場合 `valueTypes`で指定した型とそのスーパークラスとを比較した場合
`static java.util.List<java.lang.Class<?>>`	`getAncestorClasses(java.lang.Class<?> clazz)` クラスの全ての祖先を取得する。祖先のリストの並び順は、`clazz`からの近さ順となる。 `Object`は取得結果リストに含まれない。そのため、`clazz`が`Object`以外を継承していないクラスである場合、空のリストを返す。
`static java.lang.reflect.Method`	`getGetterMethod(java.lang.Class<?> targetClass, java.lang.String propertyName)` getterメソッドを検索する。
`static java.lang.String`	`getGetterMethodName(java.lang.String propertyName)` プロパティ名からgetterメソッド名を取得する。
`static java.util.List<java.lang.reflect.Method>`	`getGetterMethods(java.lang.Class<?> clazz)` クラスにあるgetterのリストを取得する。 `Object.getClass()`は取得対象から除く。 getterが一つも定義されていない場合は空のリストを返す。
`static java.lang.Object`	`getProperty(java.lang.Object object, java.lang.String propertyName)` オブジェクトからプロパティの値を取得する。
`static java.lang.Object`	`getPropertyIfExists(java.lang.Object object, java.lang.String propertyName)` オブジェクトに、指定したプロパティが存在する場合に値を取得する。プロパティが存在しなかった場合は`null`を返す。
`static java.lang.String`	`getPropertyNameFromGetter(java.lang.reflect.Method method)` getterメソッドからプロパティ名を取得する。
`static java.lang.String`	`getPropertyNameFromSetter(java.lang.reflect.Method method)` setterメソッドからプロパティ名を取得する。
`static java.lang.Class<?>`	`getPropertyType(java.lang.Class<?> clazz, java.lang.String propertyName)` プロパティの型を取得する。 setterが定義されているプロパティのみ取得可能である。該当するプロパティが見つからない場合は`null`を返す。
`static java.lang.reflect.Method`	`getSetterMethod(java.lang.Class<?> targetClass, java.lang.String propertyName)` setterメソッドを検索する。
`static java.lang.String`	`getSetterMethodName(java.lang.String propertyName)` プロパティ名からsetterメソッド名を取得する。
`static java.util.List<java.lang.reflect.Method>`	`getSetterMethods(java.lang.Class<?> clazz)` `clazz`に定義されたsetterのリストを取得する。 setterが一つも定義されていない場合は空のリストを返す。
`static java.util.List<java.lang.String>`	`getWritablePropertyNames(java.lang.Class<?> clazz)` `clazz`に定義されたプロパティの名称リストを取得する。 setterが定義されているプロパティのみが対象となる。 `clazz`にsetterが定義されたプロパティがない場合、空のリストを返す。
`static void`	`setProperty(java.lang.Object obj, java.lang.String propertyName, java.lang.Object value)` オブジェクトのプロパティに値を設定する。本メソッドでは、対象プロパティがstaticの場合でも値は設定される。
`static void`	`setProperty(java.lang.Object obj, java.lang.String propertyName, java.lang.Object value, boolean allowStatic)` オブジェクトのプロパティに値を設定する。本メソッドでは、対象プロパティがstaticの場合に値を設定するかどうかを引数で制御できる。引数allowStaticが`false`（許容しない）かつ対象プロパティがstaticである場合、例外が発生する。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createInstance
```
public static <T> T createInstance(java.lang.String className)
```
    クラス名からインスタンスを生成する。
    
    Type Parameters:
    
    T - 型引数
    
    Parameters:
    
    className - 完全修飾クラス名
    
    Returns:
    
    インスタンス
    
    Throws:
    
    java.lang.IllegalArgumentException - インスタンスの生成に失敗した場合
  - setProperty
```
public static void setProperty(java.lang.Object obj,
                               java.lang.String propertyName,
                               java.lang.Object value)
```
    オブジェクトのプロパティに値を設定する。本メソッドでは、対象プロパティがstaticの場合でも値は設定される。
    
    Parameters:
    
    obj - 対象のオブジェクト
    
    propertyName - プロパティ名
    
    value - 設定する値(NOT null)
    
    Throws:
    
    java.lang.RuntimeException - 対象プロパティにsetterが定義されていない場合か、対象プロパティのsetterが対象プロパティの型かそのサブクラスを引数にとらない場合
  - setProperty
```
public static void setProperty(java.lang.Object obj,
                               java.lang.String propertyName,
                               java.lang.Object value,
                               boolean allowStatic)
```
    オブジェクトのプロパティに値を設定する。本メソッドでは、対象プロパティがstaticの場合に値を設定するかどうかを引数で制御できる。引数allowStaticがfalse（許容しない）かつ対象プロパティがstaticである場合、例外が発生する。
    
    Parameters:
    
    obj - 対象のオブジェクト
    
    propertyName - プロパティ名
    
    value - 設定する値(NOT null)
    
    allowStatic - staticなプロパティに対する値の設定を許容するかどうか
    
    Throws:
    
    java.lang.RuntimeException - 対象プロパティにsetterが定義されていない場合か、対象プロパティのsetterが対象プロパティの型かそのサブクラスを引数にとらない場合
    
    IllegalConfigurationException - 引数allowStaticがfalse（許容しない）かつ対象プロパティがstaticである場合。 (システムプロパティやweb.xml等の設定誤り)
  - getSetterMethodName
```
public static java.lang.String getSetterMethodName(java.lang.String propertyName)
```
    プロパティ名からsetterメソッド名を取得する。
    
    Parameters:
    
    propertyName - プロパティ名
    
    Returns:
    
    setterメソッド名
  - findMatchMethod
```
public static java.lang.reflect.Method findMatchMethod(java.lang.Class<?> objectClass,
                                                       java.lang.String methodName,
                                                       java.lang.Class<?>... valueTypes)
```
    指定したシグネチャにマッチするメソッドを検索する。
    マッチするメソッドが見つからなかった場合はnullを返す。
    マッチング条件は以下である。
    - methodNameとメソッド名が一致していること
    - valueTypesと引数の数が一致していること
    - valueTypesと引数の型が一致していること。ただし、以下の場合は「同一の型」と見なす。
      
      プリミティブ型とそのラッパー型とを比較した場合
      
      valueTypesで指定した型とそのスーパークラスとを比較した場合
    Parameters:
    
    objectClass - 検索対象のクラス
    
    methodName - メソッド名
    
    valueTypes - 引数の型リスト(NOT null)。引数の型の他、そのサブクラスでもマッチする。引数を取らないメソッドを検索する場合は、空の配列を引き渡す。
    
    Returns:
    
    検索されたメソッド
  - getAncestorClasses
```
public static java.util.List<java.lang.Class<?>> getAncestorClasses(java.lang.Class<?> clazz)
```
    クラスの全ての祖先を取得する。
    祖先のリストの並び順は、clazzからの近さ順となる。
    Objectは取得結果リストに含まれない。
    そのため、clazzがObject以外を継承していないクラスである場合、空のリストを返す。
    
    Parameters:
    
    clazz - 祖先を取得するクラス
    
    Returns:
    
    クラスの全ての祖先のリスト
  - getPropertyType
```
public static java.lang.Class<?> getPropertyType(java.lang.Class<?> clazz,
                                                 java.lang.String propertyName)
```
    プロパティの型を取得する。
    setterが定義されているプロパティのみ取得可能である。
    該当するプロパティが見つからない場合はnullを返す。
    
    Parameters:
    
    clazz - プロパティの型を取得するクラス
    
    propertyName - プロパティ名
    
    Returns:
    
    プロパティの型
  - getWritablePropertyNames
```
public static java.util.List<java.lang.String> getWritablePropertyNames(java.lang.Class<?> clazz)
```
    clazzに定義されたプロパティの名称リストを取得する。 setterが定義されているプロパティのみが対象となる。
    clazzにsetterが定義されたプロパティがない場合、空のリストを返す。
    
    Parameters:
    
    clazz - 取得対象のクラス
    
    Returns:
    
    clazzに定義されたプロパティの名称リスト(setterが定義されているプロパティのみ取得する)
  - getPropertyNameFromSetter
```
public static java.lang.String getPropertyNameFromSetter(java.lang.reflect.Method method)
```
    setterメソッドからプロパティ名を取得する。
    
    Parameters:
    
    method - セッタメソッド
    
    Returns:
    
    プロパティ名
    
    Throws:
    
    java.lang.IllegalArgumentException - methodの名称が"set"で開始していない場合
  - getSetterMethods
```
public static java.util.List<java.lang.reflect.Method> getSetterMethods(java.lang.Class<?> clazz)
```
    clazzに定義されたsetterのリストを取得する。
    setterが一つも定義されていない場合は空のリストを返す。
    
    Parameters:
    
    clazz - 取得対象のクラス
    
    Returns:
    
    clazzに定義されたセッタのリスト
  - getSetterMethod
```
public static java.lang.reflect.Method getSetterMethod(java.lang.Class<?> targetClass,
                                                       java.lang.String propertyName)
```
    setterメソッドを検索する。
    
    Parameters:
    
    targetClass - ターゲットのクラス
    
    propertyName - プロパティ名
    
    Returns:
    
    setterメソッド
    
    Throws:
    
    java.lang.RuntimeException - propertyNameに対応するsetterがない場合
  - getGetterMethod
```
public static java.lang.reflect.Method getGetterMethod(java.lang.Class<?> targetClass,
                                                       java.lang.String propertyName)
```
    getterメソッドを検索する。
    
    Parameters:
    
    targetClass - ターゲットのクラス
    
    propertyName - プロパティ名
    
    Returns:
    
    getterメソッド
    
    Throws:
    
    java.lang.RuntimeException - propertyNameに対応するgetterがない場合
  - getGetterMethodName
```
public static java.lang.String getGetterMethodName(java.lang.String propertyName)
```
    プロパティ名からgetterメソッド名を取得する。
    
    Parameters:
    
    propertyName - プロパティ名
    
    Returns:
    
    getterメソッド名
    
    Throws:
    
    java.lang.IllegalArgumentException - propertyNameがnullか空文字である場合
  - getPropertyNameFromGetter
```
public static java.lang.String getPropertyNameFromGetter(java.lang.reflect.Method method)
```
    getterメソッドからプロパティ名を取得する。
    
    Parameters:
    
    method - getterメソッド
    
    Returns:
    
    プロパティ名
    
    Throws:
    
    java.lang.IllegalArgumentException - methodの名前が"get"で開始していない場合
  - getGetterMethods
```
public static java.util.List<java.lang.reflect.Method> getGetterMethods(java.lang.Class<?> clazz)
```
    クラスにあるgetterのリストを取得する。
    Object.getClass()は取得対象から除く。
    getterが一つも定義されていない場合は空のリストを返す。
    
    Parameters:
    
    clazz - 取得対象のクラス
    
    Returns:
    
    クラスにあるgetterのリスト
  - getProperty
```
public static java.lang.Object getProperty(java.lang.Object object,
                                           java.lang.String propertyName)
```
    オブジェクトからプロパティの値を取得する。
    Parameters:
    
    object - Map、またはプロパティ名のgetterを備えたオブジェクト
    
    propertyName - プロパティ名
    
    Returns:
    
    プロパティの値
    
    Throws:
    java.lang.IllegalArgumentException -
    
    objectがnullである場合
    
    propertyNameがnullか空文字である場合
    
    propertyNameに対応する、getterメソッドが定義されたプロパティがない場合
  - getPropertyIfExists
```
public static java.lang.Object getPropertyIfExists(java.lang.Object object,
                                                   java.lang.String propertyName)
```
    オブジェクトに、指定したプロパティが存在する場合に値を取得する。
    プロパティが存在しなかった場合はnullを返す。
    Parameters:
    
    object - Mapまたはプロパティ名のgetterを備えたオブジェクト
    
    propertyName - プロパティ名
    
    Returns:
    プロパティの値
    
    objectがnullである場合
    
    propertyNameがnullか空文字である場合
  - createExceptionsClassList
```
public static java.util.List<java.lang.Class<? extends java.lang.RuntimeException>> createExceptionsClassList(java.util.List<java.lang.String> originalExceptions)
```
    例外の名称のリストから例外クラスのリストを生成する。
    指定されたList<String>の各要素を Class<? extends RuntimeException>に変換し返却する。
    例外クラスは、originalExceptionsの文字列クラス名の格納順にリストに格納されて返される。
    originalExceptionsが空の場合は、空のリストを返す。
    
    Parameters:
    
    originalExceptions - 例外クラス名リスト。(List<String>)
    
    Returns:
    
    例外クラスリスト。(List<Class<? extends RuntimeException>>)
    
    Throws:
    
    java.lang.RuntimeException - 要素内の文字列クラス名が、RuntimeExceptionのサブクラス以外の場合

Class ObjectUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createInstance

setProperty

setProperty

getSetterMethodName

findMatchMethod

getAncestorClasses

getPropertyType

getWritablePropertyNames

getPropertyNameFromSetter

getSetterMethods

getSetterMethod

getGetterMethod

getGetterMethodName

getPropertyNameFromGetter

getGetterMethods

getProperty

getPropertyIfExists

createExceptionsClassList