jp.terasoluna.fw.web.struts.actions
クラス AbstractDownloadObject

java.lang.Object
  上位を拡張 jp.terasoluna.fw.web.struts.actions.AbstractDownloadObject
すべての実装されたインタフェース:
java.io.Serializable
直系の既知のサブクラス:
DownloadByteArray, DownloadFile, DownloadInputStream, DownloadString

public abstract class AbstractDownloadObject
extends java.lang.Object
implements java.io.Serializable

ダウンロード内容を保持する抽象クラス。

関連項目:
直列化された形式

フィールドの概要
protected  java.util.Map<java.lang.String,java.util.List<java.lang.String>> additionalHeaders
          追加されるヘッダを保持するマップ。
protected  java.lang.String charset
          エンコーディング。
protected  java.lang.String contentType
          コンテントタイプ。
static java.lang.String DEFAULT_CHARSET
          デフォルトのエンコーディング(UTF-8)
static java.lang.String DEFAULT_CONTENT_TYPE
          デフォルトのコンテントタイプ(application/octetstream)
protected  java.lang.String name
          ダウンロード名。
static java.lang.String NO_DOWNLOAD_CONTENT_ERROR
          ダウンロード内容が存在しない場合のエラーコード。
 
コンストラクタの概要
AbstractDownloadObject(java.lang.String name, java.lang.String contentType, java.lang.String charset)
          コンストラクタ。
 
メソッドの概要
 void addHeader(java.lang.String name, java.lang.String value)
          追加のレスポンスヘッダを設定する。
 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAdditionalHeaders()
          追加のレスポンスヘッダを取得する。
 java.lang.String getCharset()
          エンコーディングを取得する。
 java.lang.String getContentType()
          コンテントタイプを取得する。
abstract  int getLengthOfData()
          ダウンロードサイズを取得する。
 java.lang.String getName()
          ダウンロード名を取得する。
 java.io.InputStream getStream()
          ダウンロード内容のストリームを取得する。
protected abstract  java.io.InputStream getStreamInternal()
          ダウンロード内容のストリームを内部的に取得する。
 void setCharset(java.lang.String charset)
          エンコーディングを設定する。
 void setContentType(java.lang.String contentType)
          コンテントタイプを設定する。
 void setName(java.lang.String name)
          ダウンロード名を設定する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

DEFAULT_CHARSET

public static final java.lang.String DEFAULT_CHARSET
デフォルトのエンコーディング(UTF-8)

関連項目:
定数フィールド値

DEFAULT_CONTENT_TYPE

public static final java.lang.String DEFAULT_CONTENT_TYPE
デフォルトのコンテントタイプ(application/octetstream)

関連項目:
定数フィールド値

NO_DOWNLOAD_CONTENT_ERROR

public static final java.lang.String NO_DOWNLOAD_CONTENT_ERROR
ダウンロード内容が存在しない場合のエラーコード。

関連項目:
定数フィールド値

contentType

protected java.lang.String contentType
コンテントタイプ。


name

protected java.lang.String name
ダウンロード名。


charset

protected java.lang.String charset
エンコーディング。


additionalHeaders

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> additionalHeaders
追加されるヘッダを保持するマップ。

コンストラクタの詳細

AbstractDownloadObject

public AbstractDownloadObject(java.lang.String name,
                              java.lang.String contentType,
                              java.lang.String charset)
コンストラクタ。

パラメータ:
name - ダウンロード名。
contentType - コンテントタイプ。
charset - エンコーディング。
メソッドの詳細

getCharset

public java.lang.String getCharset()
エンコーディングを取得する。

戻り値:
エンコーディング。

setCharset

public void setCharset(java.lang.String charset)
エンコーディングを設定する。

パラメータ:
charset - エンコーディング。

getContentType

public java.lang.String getContentType()
コンテントタイプを取得する。

戻り値:
コンテントタイプ。

setContentType

public void setContentType(java.lang.String contentType)
コンテントタイプを設定する。

パラメータ:
contentType - コンテントタイプ。

getName

public java.lang.String getName()
ダウンロード名を取得する。

戻り値:
ダウンロード名。

setName

public void setName(java.lang.String name)
ダウンロード名を設定する。

パラメータ:
name - ダウンロード名。

getStream

public java.io.InputStream getStream()
                              throws java.io.IOException
ダウンロード内容のストリームを取得する。

戻り値:
ストリーム。
例外:
java.io.IOException

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)
追加のレスポンスヘッダを設定する。

パラメータ:
name - ヘッダ名。
value - ヘッダの値。

getAdditionalHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAdditionalHeaders()
追加のレスポンスヘッダを取得する。

戻り値:
追加のレスポンスヘッダ。

getStreamInternal

protected abstract java.io.InputStream getStreamInternal()
                                                  throws java.io.IOException
ダウンロード内容のストリームを内部的に取得する。

戻り値:
ストリーム。
例外:
java.io.IOException

getLengthOfData

public abstract int getLengthOfData()
ダウンロードサイズを取得する。

戻り値:
ダウンロードサイズ。