SessionDirectiveAdd (PEXA API Document)

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

すべての実装されたインタフェース:: java.io.Serializable, SessionDirective, SessionDirectiveSource, DirectiveMeta

public class SessionDirectiveAdd
extends java.lang.Object
implements SessionDirective, SessionDirectiveSource, DirectiveMeta

SessionDirectiveの"Add"実装クラス

        書式: &Add:Add対象SessionKey:加算値
        書式２：&Add:{Add対象SessionKey}
        加算値を保持するSessionKeyについては、Keyに続けてパス式を記述することも可能
        加算値にはマイナスを含む数値を指定してもよい。
  内容：Add対象SessionKeyに加算値を加算した値が返される
        注意：Add対象SessionKeyの値自身は変更されない、変更したい場合は、左辺にAdd対象SessionKeyを指定すること
        記述例１：Bに+10した値をＡに設定する
                A               &Add:{10}
 記述例２：Bに-10した値をＡに設定する
                A               &Add:{-10}
 記述例３：Aに+10する
                A               &Add:{10}
 記述例４：AにB+Cを設定する
                A               &Add:
        記述例５：ＡにA+Cを設定する
                A               &Add:

作成者:: namako
関連項目:: 直列化された形式

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

コンストラクタ
コンストラクタと説明
`SessionDirectiveAdd()` デフォルトコンストラクタ。
`SessionDirectiveAdd(Key sessionKey, SessionValueProducer leftProducer, SessionValueProducer rightProducer)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDirectiveString()` Directiveの名前を返す
`SessionDirective`	`getInstance(Resource resource, Key sessionKey, java.lang.String paramString)` SessionDirectiveインスタンスを生成する。
`DirectiveMeta`	`getMetaInfo()` SessionDirectiveのMeta情報を返す
`int`	`getParameterNumber()` パラメータの数を返す
`java.util.List`	`getParameters()` Parameterのリスト(編集不可)を返す。
`Parameter`	`getParamterType(int position)` x番目のパラメータの型を返す。
`ReturnParameter`	`getReturnType()` 戻りの型を返す
`java.lang.String`	`getSessionDirectiveString()` Directive部の文字列を返す(DirectivePrefixは含まない)
`java.lang.Object`	`getValue(Session session)` sessionの内容に基づく値を返す。
`int`	`hashCode()`
`java.lang.String`	`toString()`

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

- コンストラクタの詳細
  - SessionDirectiveAdd
```
public SessionDirectiveAdd()
```
    デフォルトコンストラクタ。SessionDirectiveSourceとして初期化する場合のみ利用する。
  - SessionDirectiveAdd
```
public SessionDirectiveAdd(Key sessionKey,
                           SessionValueProducer leftProducer,
                           SessionValueProducer rightProducer)
```
- メソッドの詳細
  - getValue
```
public java.lang.Object getValue(Session session)
                          throws DirectiveConvertException
```
    インタフェースからコピーされた説明: SessionDirective
    
    sessionの内容に基づく値を返す。
    
    定義:
    
    getValue インタフェース内 SessionDirective
    
    戻り値:
    
    例外:
    
    DirectiveConvertException
  - getSessionDirectiveString
```
public java.lang.String getSessionDirectiveString()
```
    インタフェースからコピーされた説明: SessionDirectiveSource
    
    Directive部の文字列を返す(DirectivePrefixは含まない)
    
    定義:
    
    getSessionDirectiveString インタフェース内 SessionDirectiveSource
    
    戻り値:
  - getInstance
```
public SessionDirective getInstance(Resource resource,
                                    Key sessionKey,
                                    java.lang.String paramString)
                             throws FatalException
```
    インタフェースからコピーされた説明: SessionDirectiveSource
    
    SessionDirectiveインスタンスを生成する。
    
    定義:
    
    getInstance インタフェース内 SessionDirectiveSource
    
    戻り値:
    
    例外:
    
    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
  - getMetaInfo
```
public DirectiveMeta getMetaInfo()
```
    インタフェースからコピーされた説明: SessionDirective
    
    SessionDirectiveのMeta情報を返す
    
    定義:
    
    getMetaInfo インタフェース内 SessionDirective
    
    戻り値:
    
    SessionDirectiveメタ情報
  - getParameterNumber
```
public int getParameterNumber()
```
    インタフェースからコピーされた説明: DirectiveMeta
    
    パラメータの数を返す
    
    定義:
    
    getParameterNumber インタフェース内 DirectiveMeta
    
    戻り値:
  - getDirectiveString
```
public java.lang.String getDirectiveString()
```
    インタフェースからコピーされた説明: DirectiveMeta
    
    Directiveの名前を返す
    
    定義:
    
    getDirectiveString インタフェース内 DirectiveMeta
    
    戻り値:
  - getReturnType
```
public ReturnParameter getReturnType()
```
    インタフェースからコピーされた説明: DirectiveMeta
    
    戻りの型を返す
    
    定義:
    
    getReturnType インタフェース内 DirectiveMeta
    
    戻り値:
  - getParamterType
```
public Parameter getParamterType(int position)
```
    インタフェースからコピーされた説明: DirectiveMeta
    
    x番目のパラメータの型を返す。
    
    定義:
    
    getParamterType インタフェース内 DirectiveMeta
    
    パラメータ:
    
    position - パラメータの位置(0,1,..,n)
  - getParameters
```
public java.util.List getParameters()
```
    インタフェースからコピーされた説明: DirectiveMeta
    
    Parameterのリスト(編集不可)を返す。
    
    定義:
    
    getParameters インタフェース内 DirectiveMeta
    
    戻り値:
    
    パラメータが0個の場合は空のリストを返す

クラス SessionDirectiveAdd

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

メソッドのサマリー

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

コンストラクタの詳細

SessionDirectiveAdd

SessionDirectiveAdd

メソッドの詳細

getValue

getSessionDirectiveString

getInstance

toString

hashCode

equals

getMetaInfo

getParameterNumber

getDirectiveString

getReturnType

getParamterType

getParameters