Kagetaka

net.hizlab.kagetaka.net
クラス MessageHeader

java.lang.Object
  拡張net.hizlab.kagetaka.net.MessageHeader

public class MessageHeader
extends Object

RFC 844 と MIME ヘッダーを表すクラスです。

バージョン:
$Revision: 1.4 $

コンストラクタの概要
MessageHeader()
          新しいインスタンスを作成します。
 
メソッドの概要
 void add(String key, String value)
          値を追加します。
 String get(int index)
          値を取得します。
 String get(String key)
          値を取得します。
 Hashtable getHeaders()
          ヘッダーの一覧を返します。
 Hashtable getHeaders(String[] excludeList)
          ヘッダーの一覧を返します。
 String keyAt(int index)
          キーを取得します。
 boolean merge(InputStream is)
          入力ストリームからヘッダーに追加します。
 boolean parse(InputStream is)
          入力ストリームからヘッダーを読み取ります。
 void prepend(String key, String value)
          先頭に値を追加します。
 void remove(int index)
          キーと値のペアを削除します。
 void reset()
          空にします。
 void set(int index, String key, String value)
          指定したインデックスのキーと値を設定します。
 void set(String key, String value)
          値を追加します。
 void setIfNotSet(String key, String value)
          キーが存在しないときのみ値を追加します。
 String toString()
          文字列表現を返します。
 void write(TextOutputStream out)
          内容を出力します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

MessageHeader

public MessageHeader()
新しいインスタンスを作成します。

メソッドの詳細

add

public void add(String key,
                String value)
値を追加します。

パラメータ:
key - キー
value - 値

get

public String get(int index)
値を取得します。

パラメータ:
index - インデックス
戻り値:
値、存在しない場合は null

get

public String get(String key)
値を取得します。

パラメータ:
key - キー
戻り値:
値、存在しない場合は null

getHeaders

public Hashtable getHeaders()
ヘッダーの一覧を返します。

戻り値:
ヘッダー一覧

getHeaders

public Hashtable getHeaders(String[] excludeList)
ヘッダーの一覧を返します。

パラメータ:
excludeList - 一覧に含まないリスト
戻り値:
ヘッダー一覧

keyAt

public String keyAt(int index)
キーを取得します。

パラメータ:
index - インデックス
戻り値:
値、存在しない場合は null

merge

public boolean merge(InputStream is)
              throws IOException
入力ストリームからヘッダーに追加します。

パラメータ:
is - 入力ストリーム
戻り値:
正常に読め込めた場合は true、 途中でストリームの最後に達してしまった場合は false
例外:
IOException - IO エラーが発生した場合

parse

public boolean parse(InputStream is)
              throws IOException
入力ストリームからヘッダーを読み取ります。

パラメータ:
is - 入力ストリーム
戻り値:
正常に読め込めた場合は true、 途中でストリームの最後に達してしまった場合は false
例外:
IOException - IO エラーが発生した場合

prepend

public void prepend(String key,
                    String value)
先頭に値を追加します。

パラメータ:
key - キー
value - 値

remove

public void remove(int index)
キーと値のペアを削除します。

パラメータ:
index - インデックス

reset

public void reset()
空にします。


set

public void set(int index,
                String key,
                String value)
指定したインデックスのキーと値を設定します。

パラメータ:
index - インデックス
key - キー
value - 値

set

public void set(String key,
                String value)
値を追加します。既にキーが存在する場合は上書きされます。

パラメータ:
key - キー
value - 値

setIfNotSet

public void setIfNotSet(String key,
                        String value)
キーが存在しないときのみ値を追加します。

パラメータ:
key - キー
value - 値

toString

public String toString()
文字列表現を返します。

戻り値:
文字列表現

write

public void write(TextOutputStream out)
           throws IOException
内容を出力します。

パラメータ:
out - 出力ストリーム
例外:
IOException - IO エラーが発生した場合

Kagetaka

Copyright (c) 2002-2004 The Kagetaka Project 'November 20, 2004'