NamedParameter (jdbc-util 0.3.3 API)

java.lang.Object
- net.osdn.util.sql.NamedParameter

```
public class NamedParameter
extends java.lang.Object
```
名前付きパラメータークラスです。
通常、このクラスのインスタンスを直接生成することはありません。 NamedParameterのインスタンスはNamedParameterStatementの各メソッドによって生成され、 NamedParameterStatement内部に保持されます。

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプクラスと説明

static class NamedParameter.Method

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`NamedParameter.Method`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`NamedParameter(NamedParameter.Method method, int index, java.lang.String name, java.lang.Object value)` 名前付きパラメーターを作成します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`applyTo(java.sql.PreparedStatement st)` 指定したPreparedStatementにこのパラメーターを設定します。
`java.util.Calendar`	`getCalendar()` このパラメーターを設定する際に使用するCalendarを取得します。
`int`	`getIndex()` パラメーターの出現順を取得します。
`long`	`getLength()` パラメーターの長さを取得します。
`NamedParameter.Method`	`getMethod()` `applyTo(PreparedStatement)`メソッドを呼び出してPreparedStatementにパラメーターを設定する際に呼び出されるメソッドを取得します。
`java.lang.String`	`getName()` パラメーターの名前を取得します。
`int`	`getType()` このパラメーターを設定する際に使用されるSQL型コードを取得します。
`java.lang.String`	`getTypeName()` このパラメーターを設定する際に使用するSQLユーザー定義型の完全指定の名前を取得します。
`java.lang.Object`	`getValue()` パラメーターの値を取得します。
`void`	`setCalendar(java.util.Calendar calendar)` このパラメーターを設定する際に使用するCalendarを設定します。
`void`	`setIndex(int index)` パラメーターの出現順を設定します。
`void`	`setLength(long length)` パラメーターの長さを設定します。
`void`	`setMethod(NamedParameter.Method method)` `applyTo(PreparedStatement)`メソッドを呼び出してPreparedStatementにパラメーターを設定する際に呼び出されるメソッドを設定します。
`void`	`setName(java.lang.String name)` パラメーターの名前を設定します。
`void`	`setType(int type)` このパラメーターを設定する際に使用するSQL型コードを設定します。
`void`	`setTypeName(java.lang.String typeName)` このパラメーターを設定する際に使用するSQLユーザー定義型の完全指定の名前を設定します。
`void`	`setValue(java.lang.Object value)` パラメーターの値を設定します。

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

- コンストラクタの詳細
  - NamedParameter
```
public NamedParameter(NamedParameter.Method method,
                      int index,
                      java.lang.String name,
                      java.lang.Object value)
```
    名前付きパラメーターを作成します。
    
    パラメータ:
    
    method - applyTo(PreparedStatement)メソッドを呼び出してPreparedStatementにパラメーターを設定する際に呼び出されるメソッドを指定します。
    
    index - PreparedStatementにパラメーターを設定する際のパラメーター ?の出現順を指定します。
    
    name - パラメーターの名前
    
    value - パラメーターの値
- メソッドの詳細
  - setMethod
```
public void setMethod(NamedParameter.Method method)
```
    applyTo(PreparedStatement)メソッドを呼び出してPreparedStatementにパラメーターを設定する際に呼び出されるメソッドを設定します。
    
    パラメータ:
    
    method - メソッドを表すNamedParameter.Methodの値
  - getMethod
```
public NamedParameter.Method getMethod()
```
    applyTo(PreparedStatement)メソッドを呼び出してPreparedStatementにパラメーターを設定する際に呼び出されるメソッドを取得します。
    
    戻り値:
    
    メソッドを表すNamedParameter.Methodの値
  - setIndex
```
public void setIndex(int index)
```
    パラメーターの出現順を設定します。
    
    パラメータ:
    
    index - パラメーターの出現順。0以下の値を指定するとIllegalArgumentExceptionがスローされます。
  - getIndex
```
public int getIndex()
```
    パラメーターの出現順を取得します。
    
    戻り値:
    
    パラメーターの出現順
  - setName
```
public void setName(java.lang.String name)
```
    パラメーターの名前を設定します。
    
    パラメータ:
    
    name - パラメーターの名前
  - getName
```
public java.lang.String getName()
```
    パラメーターの名前を取得します。
    
    戻り値:
    
    パラメーターの名前
  - setValue
```
public void setValue(java.lang.Object value)
```
    パラメーターの値を設定します。
    
    パラメータ:
    
    value - パラメーターの値
  - getValue
```
public java.lang.Object getValue()
```
    パラメーターの値を取得します。
    
    戻り値:
    
    パラメーターの値
  - setLength
```
public void setLength(long length)
```
    パラメーターの長さを設定します。
    この値はapplyTo(PreparedStatement)メソッドを呼び出してPreparedStatementにパラメーターを設定する際に使われます。ただし、setMethod(Method)メソッドで次のいずれかの値が設定されている場合に限ります: SET_ASCII_STREAM、SET_BINARY_STREAM、SET_BLOB、SET_CHARACTER_STREAM、SET_CLOB、SET_NCHARACTER_STREAM、SET_NCLOB、SET_OBJECT
    
    上記のメソッド以外が設定されている場合はパラメーターの長さは無視されます。
    
    パラメータ:
    
    length - パラメーターの長さ。0以下の値を指定するとパラメーターの長さが設定されていなものとして扱われます。
  - getLength
```
public long getLength()
```
    パラメーターの長さを取得します。
    
    戻り値:
    
    パラメーターの長さ。0以下の値はパラメーターの長さが設定されていないことを表しています。
  - setCalendar
```
public void setCalendar(java.util.Calendar calendar)
```
    このパラメーターを設定する際に使用するCalendarを設定します。
    この値はapplyTo(PreparedStatement)メソッドを呼び出してPreparedStatementにパラメーターを設定する際に使われます。ただし、setMethod(Method)メソッドで次のいずれかの値が設定されている場合に限ります: SET_DATE、SET_TIME、SET_TIMESTAMP
    
    上記のメソッド以外が設定されている場合はCalendarは無視されます。
    
    パラメータ:
    
    calendar - パラメーターを設定する際に使用するCalendar。既定のタイムゾーンを使用する場合はnullを指定します。
  - getCalendar
```
public java.util.Calendar getCalendar()
```
    このパラメーターを設定する際に使用するCalendarを取得します。
    
    戻り値:
    
    パラメーターを設定する際に使用するCalendar。設定されていない場合は null を返します。
  - setType
```
public void setType(int type)
```
    このパラメーターを設定する際に使用するSQL型コードを設定します。
    この値はapplyTo(PreparedStatement)メソッドを呼び出してPreparedStatementにパラメーターを設定する際に使われます。ただし、setMethod(Method)メソッドで次のいずれかの値が設定されている場合に限ります: SET_NULL、SET_OBJECT
    
    上記のメソッド以外が設定されている場合はtypeは無視されます。
    
    パラメータ:
    
    type - java.sql.Typesで定義されるSQL型コード
  - getType
```
public int getType()
```
    このパラメーターを設定する際に使用されるSQL型コードを取得します。
    
    戻り値:
    
    java.sql.Typesで定義されるSQL型コード。設定されていない場合は0を返します。
  - setTypeName
```
public void setTypeName(java.lang.String typeName)
```
    このパラメーターを設定する際に使用するSQLユーザー定義型の完全指定の名前を設定します。
    この値はapplyTo(PreparedStatement)メソッドを呼び出してPreparedStatementにパラメーターを設定する際に使われます。ただし、setMethod(Method)メソッドで次のいずれかの値が設定されている場合に限ります: SET_NULL
    
    上記のメソッド以外が設定されている場合はtypeNameは無視されます
    
    パラメータ:
    
    typeName - SQLユーザー定義型の完全指定の名前。パラメーターがユーザー定義型でもREFでもない場合は無視されます。
  - getTypeName
```
public java.lang.String getTypeName()
```
    このパラメーターを設定する際に使用するSQLユーザー定義型の完全指定の名前を取得します。
    
    戻り値:
    
    SQLユーザー定義型の完全指定の名前。
  - applyTo
```
public void applyTo(java.sql.PreparedStatement st)
             throws java.sql.SQLException
```
    指定したPreparedStatementにこのパラメーターを設定します。
    
    パラメータ:
    
    st - PreparedStatement
    
    例外:
    
    java.sql.SQLException - PreparedStatementの各パラメーター設定メソッドがSQLExceptionをスローした場合

クラス NamedParameter

ネストされたクラスのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

コンストラクタの詳細

NamedParameter

メソッドの詳細

setMethod

getMethod

setIndex

getIndex

setName

getName

setValue

getValue

setLength

getLength

setCalendar

getCalendar

setType

getType

setTypeName

getTypeName

applyTo