SessionDirectiveRead (PEXA API Document)

java.lang.Object
- pexa.share.session.directive.base.SessionDirectiveRead

すべての実装されたインタフェース:

java.io.Serializable, SessionDirective, SessionDirectiveSource, DirectiveMeta
```
public class SessionDirectiveRead
extends java.lang.Object
implements SessionDirective, SessionDirectiveSource, DirectiveMeta, java.io.Serializable
```
SessionDirectiveの"&Read"実装。
パラメータで指定されたファイルを読み込んで、StringもしくはBinaryとして内容を返す。
```
                &Read:{ file }{ type }{ encoding } ; fileはString/File, typeはString("String","Binary"),  encodingはString
 
```
fileがnullの場合は例外を返す。
typeがnullの場合は例外を返す。
encodingがnullの場合は実行プラットフォームのデフォルトエンコーディングで読み込まれる。
バージョン:

$Revision: 5435 $ $Date:: 2010-10-01 16:27:21 #$

作成者:

morishita

関連項目:

直列化された形式

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

コンストラクタ
コンストラクタと説明
`SessionDirectiveRead()` コンストラクタ
`SessionDirectiveRead(Key sessionKey, SessionValueProducer fileProducer, SessionValueProducer outputProducer, SessionValueProducer encodingProducer)` コンストラクタ

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`equals(java.lang.Object obj)` オブジェクト同一性を判定する
`java.lang.String`	`getDirectiveString()` Directiveの名前を返す
`SessionDirective`	`getInstance(Resource resource, Key sessionKey, java.lang.String paramString)` このディレクティブのインスタンスを返す
`DirectiveMeta`	`getMetaInfo()` SessionDirectiveのMeta情報を返す
`int`	`getParameterNumber()` パラメータの数を返す
`java.util.List`	`getParameters()` Parameterのリスト(編集不可)を返す。
`Parameter`	`getParamterType(int position)` x番目のパラメータの型を返す。
`ReturnParameter`	`getReturnType()` 戻りの型を返す
`java.lang.String`	`getSessionDirectiveString()` ディレクティブ名文字列を返す
`java.lang.Object`	`getValue(Session session)` このディレクティブが表す値を返す。
`int`	`hashCode()` ハッシュコードを返す
`static java.lang.Object`	`readFile(java.io.File file, java.lang.String type, java.lang.String encoding)` ファイルの読み込みを行う
`java.lang.String`	`toString()` 文字列表現を返す

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

- コンストラクタの詳細
  - SessionDirectiveRead
```
public SessionDirectiveRead()
```
    コンストラクタ
  - SessionDirectiveRead
```
public SessionDirectiveRead(Key sessionKey,
                            SessionValueProducer fileProducer,
                            SessionValueProducer outputProducer,
                            SessionValueProducer encodingProducer)
```
    コンストラクタ
    
    パラメータ:
    
    sessionKey - セッションキー
    
    fileProducer -
    
    outputProducer -
    
    encodingProducer -
- メソッドの詳細
  - getValue
```
public java.lang.Object getValue(Session session)
                          throws DirectiveConvertException
```
    このディレクティブが表す値を返す。
    
    定義:
    
    getValue インタフェース内 SessionDirective
    
    パラメータ:
    
    session - サービスセッション
    
    戻り値:
    
    ディレクティブが表す値オブジェクト
    
    例外:
    
    DirectiveConvertException
  - readFile
```
public static java.lang.Object readFile(java.io.File file,
                                        java.lang.String type,
                                        java.lang.String encoding)
```
    ファイルの読み込みを行う
    
    パラメータ:
    
    file - 読み込み対象のファイルオブジェクト
    
    type - 読み込みデータタイプを表すクラスオブジェクト
    
    encoding - テキストファイル読込
    
    戻り値:
    
    ファイルの内容データ
  - getSessionDirectiveString
```
public java.lang.String getSessionDirectiveString()
```
    ディレクティブ名文字列を返す
    
    定義:
    
    getSessionDirectiveString インタフェース内 SessionDirectiveSource
    
    戻り値:
    
    ディレクティブ名
  - getInstance
```
public SessionDirective getInstance(Resource resource,
                                    Key sessionKey,
                                    java.lang.String paramString)
                             throws FatalException
```
    このディレクティブのインスタンスを返す
    
    定義:
    
    getInstance インタフェース内 SessionDirectiveSource
    
    パラメータ:
    
    resource - 実行時リソース
    
    paramString - ディレクティブに対するパラメータ文字列
    
    sessionKey - セッションキー
    
    戻り値:
    
    ディレクティブのインスタンス
    
    例外:
    
    FatalException
  - toString
```
public java.lang.String toString()
```
    文字列表現を返す
    
    オーバーライド:
    
    toString クラス内 java.lang.Object
    
    戻り値:
    
    ディレクティブオブジェクトの文字列表現
  - hashCode
```
public int hashCode()
```
    ハッシュコードを返す
    
    オーバーライド:
    
    hashCode クラス内 java.lang.Object
    
    戻り値:
    
    ハッシュコード
  - equals
```
public boolean equals(java.lang.Object obj)
```
    オブジェクト同一性を判定する
    
    オーバーライド:
    
    equals クラス内 java.lang.Object
    
    パラメータ:
    
    obj - 同一性の判定対象
    
    戻り値:
    
    同一オブジェクトならtrue, 違うならfalse
  - getMetaInfo
```
public DirectiveMeta getMetaInfo()
```
    SessionDirectiveのMeta情報を返す
    
    定義:
    
    getMetaInfo インタフェース内 SessionDirective
    
    戻り値:
  - getParameterNumber
```
public int getParameterNumber()
```
    パラメータの数を返す
    
    定義:
    
    getParameterNumber インタフェース内 DirectiveMeta
    
    戻り値:
    
    このDirectiveが最大で取り得るパラメータ数
    
    例外:
    
    java.rmi.RemoteException
  - getDirectiveString
```
public java.lang.String getDirectiveString()
```
    Directiveの名前を返す
    
    定義:
    
    getDirectiveString インタフェース内 DirectiveMeta
    
    戻り値:
    
    Directive名
    
    例外:
    
    java.rmi.RemoteException
  - getReturnType
```
public ReturnParameter getReturnType()
```
    戻りの型を返す
    
    定義:
    
    getReturnType インタフェース内 DirectiveMeta
    
    戻り値:
    
    このDirectiveが返す値のメタ情報
    
    例外:
    
    java.rmi.RemoteException
  - getParamterType
```
public Parameter getParamterType(int position)
```
    x番目のパラメータの型を返す。
    
    定義:
    
    getParamterType インタフェース内 DirectiveMeta
    
    パラメータ:
    
    position - パラメータの位置(0,1,..,n)
  - getParameters
```
public java.util.List getParameters()
```
    Parameterのリスト(編集不可)を返す。
    
    定義:
    
    getParameters インタフェース内 DirectiveMeta
    
    戻り値:
    
    パラメータが0個の場合は空のリストを返す
    
    例外:
    
    java.rmi.RemoteException

クラス SessionDirectiveRead

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

メソッドのサマリー

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

コンストラクタの詳細

SessionDirectiveRead

SessionDirectiveRead

メソッドの詳細

getValue

readFile

getSessionDirectiveString

getInstance

toString

hashCode

equals

getMetaInfo

getParameterNumber

getDirectiveString

getReturnType

getParamterType

getParameters