com.nec.webotx.jbi.common.io.stream
インタフェース IStreamSourceInfo


public interface IStreamSourceInfo

IRetraceableのgetSourceInfoで返されるオブジェクトのインタフェース。

作成者:
NEC Corporation.

フィールドの概要
static java.lang.String CONTENT_LENGTH_PROPERTY
          コンテンツサイズ。
static java.lang.String DEFAULT_ENCODING
          UTF-8:ストリームのデフォルト文字エンコーディング。
static long DEFAULT_LENGTH
          デフォルト値。
static java.lang.String ENCODING_PROPERTY
          ストリームの文字エンコーディング。
static java.lang.String FTP_FILE_NAME_PROPERTY
          FTP BCのダイレクト転送のためのファイル名。
static java.lang.String FTP_PROPERTIES_PROPERTY
          FTP BC情報を保存するプロパティ。
static java.lang.String NONE_ENCODING
          None:文字エンコーディングがNoneに設定された場合、変換しません。
 
メソッドの概要
 long getContentLength()
          ストリームのバイト数を返却します。
 java.lang.String getEncoding()
          ストリームの文字エンコディング情報を取得します。
 java.lang.String getFileName()
          FTP BCのダイレクト転送のファイル名を返却します。
 java.util.Properties getProperties()
          ストリームに関するプロパティをProperties形式で返却します。
 boolean isXMLFormat()
           メッセージコンテントがXML文書かどうかを返却します。
 void setContentLength(long contentLength)
          ストリームのバイトサイズを設定します。
 void setEncoding(java.lang.String encoding)
          ストリームの文字エンコーディング情報を設定します。
 void setFileName(java.lang.String fileName)
          FTP BCのダイレクト転送のファイル名を設定します。
 void setProperties(java.util.Properties properties)
          ストリームに関するプロパティをPropertiesで設定します。
 void setXMLFormat(boolean b)
           メッセージがXML文書かどうかを設定します。
 

フィールドの詳細

DEFAULT_LENGTH

static final long DEFAULT_LENGTH
デフォルト値。(ストリームの長さが分らない場合)

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

ENCODING_PROPERTY

static final java.lang.String ENCODING_PROPERTY
ストリームの文字エンコーディング。

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

CONTENT_LENGTH_PROPERTY

static final java.lang.String CONTENT_LENGTH_PROPERTY
コンテンツサイズ。 ストリームの長さのバイト数を取得できます。ただし、長さが不明のときは値を取得できません。

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

FTP_FILE_NAME_PROPERTY

static final java.lang.String FTP_FILE_NAME_PROPERTY
FTP BCのダイレクト転送のためのファイル名。

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

FTP_PROPERTIES_PROPERTY

static final java.lang.String FTP_PROPERTIES_PROPERTY
FTP BC情報を保存するプロパティ。

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

DEFAULT_ENCODING

static final java.lang.String DEFAULT_ENCODING
UTF-8:ストリームのデフォルト文字エンコーディング。

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

NONE_ENCODING

static final java.lang.String NONE_ENCODING
None:文字エンコーディングがNoneに設定された場合、変換しません。

関連項目:
定数フィールド値
メソッドの詳細

getEncoding

java.lang.String getEncoding()
ストリームの文字エンコディング情報を取得します。
 文字エンコーディング変換を行った後、文字エンコーディングは変更された可能性があります。
 この場合、文字エンコーディングを再度取得する必要があります。
 取得はProperties#getProperty(ENCODING_PROPERTY)より行います。
 これはgetProperties().getProperty(ENCODING_PROPERTY)に相当します

 デフォルトはUTF-8です。
 実装時、返り値としてnullを返すべきではありません。
 

戻り値:
ストリームの文字エンコーディング
関連項目:
getProperties(), ENCODING_PROPERTY

setEncoding

void setEncoding(java.lang.String encoding)
ストリームの文字エンコーディング情報を設定します。

 文字エンコーディング情報を設定する前に、getProperties()を呼び出して、
 propertiesがnullではないことを確認する必要があります。
 nullである場合、新しいjava.lang.Propertiesインスタンスを作成し、
 setProperties(Properties)を呼び出してください。

 引数がnullもしくは、encoding.trim().length() == 0の場合、デフォルトのUTF-8が設定されます。
 

パラメータ:
encoding - 文字エンコーディングを指定。
関連項目:
setProperties(Properties), ENCODING_PROPERTY

getContentLength

long getContentLength()
ストリームのバイト数を返却します。
 文字エンコディング変換を行った後、ストリームのバイト数は変更された可能性があります。
 この場合、バイト数を再度取得する必要があります。
 取得はProperties#getProperty(CONTENT_LENGTH_PROPERTY)より行います。
 これはgetProperties().getProperty(CONTENT_LENGTH_PROPERTY)に相当します。
 

戻り値:
long コンテンツのサイズ。
 contentLength < 0の場合、ストリームのサイズは未知。
 contentLength >= 0の場合、ストリームの実サイズを示します。
 
場合によって、返却値が以下のとおりです。 1、propertiesnullの場合はDEFAULT_LENGTHが返却されます。 2、propertiesnullではない場合はpropertiesから取得したCONTENT_LENGTH_PROPERTY属性が返却されます。
関連項目:
getProperties(), CONTENT_LENGTH_PROPERTY

setContentLength

void setContentLength(long contentLength)
ストリームのバイトサイズを設定します。
 ストリームのサイズを設定する前に、getProperties()を呼び出して、
 propertiesはnullではないことを確認する必要があります。
 nullである場合、新しいjava.lang.Propertiesインスタンスを作成し、
 setProperties(Properties)を呼び出してください。
 

パラメータ:
contentLength - ストリームのバイトサイズを指定。
関連項目:
setProperties(Properties), CONTENT_LENGTH_PROPERTY

getFileName

java.lang.String getFileName()
FTP BCのダイレクト転送のファイル名を返却します。
 取得はProperties#getProperty(FTP_FILE_NAME_PROPERTY)より行います。
 これはgetProperties().getProperty(FTP_FILE_NAME_PROPERTY)に相当します。
 

戻り値:
String ファイルの名前。

setFileName

void setFileName(java.lang.String fileName)
FTP BCのダイレクト転送のファイル名を設定します。
 ファイル名を設定する前に、getProperties()を呼び出して、
 propertiesはnullではないことを確認する必要があります。
 nullである場合、新しいjava.lang.Propertiesインスタンスを作成し、
 setProperties(Properties)を呼び出してください。
 

パラメータ:
fileName - ファイル名を指定。
関連項目:
setProperties(Properties), FTP_FILE_NAME_PROPERTY

getProperties

java.util.Properties getProperties()
ストリームに関するプロパティをProperties形式で返却します。
 互換性を守るために、新しい属性を定義し、Propertiesのインスタンスを作成してください。
 その場合必ず null チェックを行ってください。
 

戻り値:
Properties ストリームに関するプロパティ。

setProperties

void setProperties(java.util.Properties properties)
ストリームに関するプロパティをPropertiesで設定します。
 互換性を守るために、新しい属性を定義し、Propertiesのインスタンスを作成してください。
 

パラメータ:
properties - ストリームに関するプロパティを指定。

isXMLFormat

boolean isXMLFormat()

メッセージコンテントがXML文書かどうかを返却します。

戻り値:
XML文書ならば true

setXMLFormat

void setXMLFormat(boolean b)

メッセージがXML文書かどうかを設定します。

パラメータ:
b - XML文書かどうか


Copyright (C) 1998 - 2012 NEC Corporation. All rights reserved.