org.seasar.cubby.action
クラス Json

java.lang.Object
  org.seasar.cubby.action.Json

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

ActionResult

public class Json
extends Object
implements ActionResult

JSON 形式のレスポンスを返す ActionResult です。

アクションメソッドの戻り値としてこのインスタンスを指定することで、指定された JavaBean を JSON/JSONP 形式に変換してレスポンスを返します。 ブラウザの JavaScript から発行されたリクエストを処理する場合等に使用してください。 JavaBean/ Map/配列/Collectionなどがコンストラクタに渡すことができます。

使用例1 : JSON 形式のレスポンスを返す

 MyBean bean = ...;
 return new Json(bean);
 

使用例2 : コールバック関数名を指定して JSONP 形式のレスポンスを返す

 MyBean bean = ...;
 return new Json(bean, "callback");
 

使用例3 : コンテントタイプと文字コードを指定して JSON 形式のレスポンスを返す。
セットされるコンテントタイプは"text/javascript+json; charset=Shift_JIS"になります。

 MyBean bean = ...;
 return new Json(bean).contentType("text/javascript+json").encoding("Shift_JIS");
 

導入されたバージョン:

1.0.0

作成者:

baba, agata

関連項目:

JSON(JavaScript Object Notation)< /a>, JSONP(JSON * with Padding)< /a>, JSONSerializer.serialize(Object)

コンストラクタの概要

Json(Object bean)
JSON 形式でレスポンスを返すインスタンスを生成します。

Json(Object bean, String callback)
JSONP 形式でレスポンスを返すインスタンスを生成します。

メソッドの概要

Json	contentType(String contentType) コンテントタイプをセットします。
Json	encoding(String encoding) エンコーディングをセットします。
void	execute(Action action, Class<? extends Action> actionClass, Method method, HttpServletRequest request, HttpServletResponse response) 処理を実行します。
Object	getBean() JSON 形式に変換する JavaBeanを取得します。
String	getCallback() コールバック関数名を取得します。
String	getContentType() コンテントタイプを取得します。
String	getEncoding() エンコーディングを取得します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

Json

public Json(Object bean)

JSON 形式でレスポンスを返すインスタンスを生成します。

パラメータ:

bean - JSON 形式に変換する JavaBean/Map/配列/Collectionなど

Json

public Json(Object bean,
            String callback)

JSONP 形式でレスポンスを返すインスタンスを生成します。

パラメータ:

bean - JSONP 形式に変換する JavaBean/Map/配列/Collectionなど

callback - コールバック関数名

メソッドの詳細

getBean

public Object getBean()

JSON 形式に変換する JavaBeanを取得します。

戻り値:

JSON 形式に変換する JavaBean

getCallback

public String getCallback()

コールバック関数名を取得します。

戻り値:

コールバック関数名

contentType

public Json contentType(String contentType)

コンテントタイプをセットします。

パラメータ:

contentType - コンテントタイプ。(例："text/javascript+json")

戻り値:

Json

getContentType

public String getContentType()

コンテントタイプを取得します。

戻り値:

コンテントタイプ

encoding

public Json encoding(String encoding)

エンコーディングをセットします。

セットされたエンコーディングはコンテントタイプのcharsetとして使用されます。

パラメータ:

encoding - エンコーディング。　（例："Shift_JIS" ）

戻り値:

Json

getEncoding

public String getEncoding()

エンコーディングを取得します。

戻り値:

エンコーディング

execute

public void execute(Action action,
                    Class<? extends Action> actionClass,
                    Method method,
                    HttpServletRequest request,
                    HttpServletResponse response)
             throws Exception

処理を実行します。

定義:

インタフェース ActionResult 内の execute

パラメータ:

action - アクション

actionClass - アクションクラス

method - アクションメソッド

request - リクエスト

response - レスポンス

例外:

Exception