ts.util.resource
クラス AbstractResource

java.lang.Object
  上位を拡張 ts.util.resource.AbstractResource
すべての実装されたインタフェース:
Resource
直系の既知のサブクラス:
DefaultResource, XmlResource

public abstract class AbstractResource
extends java.lang.Object
implements Resource

リソースクラスの抽象クラス。
リソースクラスに共通の実装を定義する。

バージョン:
$Revision: 1.2 $, $Date: 2007/02/15 15:28:04 $
作成者:
佐藤隆之.

フィールドの概要
 
インタフェース ts.util.resource.Resource から継承されたフィールド
EMPTY
 
コンストラクタの概要
AbstractResource()
          デフォルトコンストラクタ。
AbstractResource(AbstractResource res)
          コピーコンストラクタ。
 
メソッドの概要
 char getAttributeMatchMark()
          キーの属性の名前と値を結び付ける文字を取得する。
 char[] getAttributeParenthesis()
          キーの属性を囲む文字を取得する。
 char getAttributeSeparator()
          キーの属性の区切り文字を取得する。
 char getElementSeparator()
          キーの要素の区切り文字を取得する。
protected  java.io.InputStream getInputStream(java.lang.String path)
          指定されたパスから入力ストリームを取得する。
protected  java.lang.String getNameOfKeyElement(java.lang.String keyElem)
          指定されたキー要素の要素名を取得する。
protected  java.io.OutputStream getOutputStream(java.lang.String path)
          指定されたパスの出力ストリームを取得する。
 java.lang.String getPath()
          ロードしたリソースファイルのパスを取得する。
protected  java.util.List<java.lang.String[]> listAttributesOfKeyElement(java.lang.String keyElem)
          指定されたキー要素の属性の名前と値の組を列挙する。
protected abstract  void load(java.io.InputStream stream)
          引数の入力ストリームからリソースファイルの内容を読み込む。
 void load(java.lang.String path)
          指定されたパスのリソースファイルを読み込む。
protected abstract  void save(java.io.OutputStream stream)
          引数の出力ストリームに、このオブジェクトが保持している内容を保存する。
 void save(java.lang.String path)
          指定されたパスのファイルに、このオブジェクトが保持している内容を保存する。
protected  void setAttributeMatchMark(char mark)
          キーの属性の名前と値を結び付ける文字を設定する。
protected  void setAttributeParenthesis(char openPar, char closePar)
          キーの属性を囲む文字を設定する。
 void setAttributeSeparator(char separator)
          キーの属性の区切り文字を設定する。
protected  void setElementSeparator(char separator)
          キーの要素の区切り文字を設定する。
protected  java.util.List<java.lang.String> splitKey(java.lang.String key)
          キーを要素ごとに分割する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース ts.util.resource.Resource から継承されたメソッド
getAttributes, getChildren, getFirstAttribute, getFirstChild, getFirstValue, getOrCreateFirstChild, getValues, removeChildren, setFirstValue
 

コンストラクタの詳細

AbstractResource

public AbstractResource()
デフォルトコンストラクタ。


AbstractResource

public AbstractResource(AbstractResource res)
コピーコンストラクタ。

パラメータ:
res - コピー元のリソースオブジェクト。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。
メソッドの詳細

setElementSeparator

protected void setElementSeparator(char separator)
キーの要素の区切り文字を設定する。

パラメータ:
separator - キーの要素の区切り文字。

getElementSeparator

public char getElementSeparator()
キーの要素の区切り文字を取得する。

戻り値:
キーの要素の区切り文字。

setAttributeParenthesis

protected void setAttributeParenthesis(char openPar,
                                       char closePar)
キーの属性を囲む文字を設定する。

パラメータ:
openPar - キーの属性を囲む開き括弧。
closePar - キーの属性を囲む閉じ括弧。

getAttributeParenthesis

public char[] getAttributeParenthesis()
キーの属性を囲む文字を取得する。

戻り値:
キーの属性を囲む文字の配列。

setAttributeSeparator

public void setAttributeSeparator(char separator)
キーの属性の区切り文字を設定する。

パラメータ:
separator - キーの属性の区切り文字。

getAttributeSeparator

public char getAttributeSeparator()
キーの属性の区切り文字を取得する。

戻り値:
キーの属性の区切り文字。

setAttributeMatchMark

protected void setAttributeMatchMark(char mark)
キーの属性の名前と値を結び付ける文字を設定する。

パラメータ:
mark - キーの属性の名前と値を結び付ける文字。

getAttributeMatchMark

public char getAttributeMatchMark()
キーの属性の名前と値を結び付ける文字を取得する。

戻り値:
キーの属性の名前と値を結び付ける文字を取得する。

getNameOfKeyElement

protected java.lang.String getNameOfKeyElement(java.lang.String keyElem)
指定されたキー要素の要素名を取得する。
{#splitKey(String) splitKey}メソッドによって分割されたキー要素から 要素名を取り出す。

パラメータ:
keyElem - キー要素。
戻り値:
要素名。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

listAttributesOfKeyElement

protected java.util.List<java.lang.String[]> listAttributesOfKeyElement(java.lang.String keyElem)
指定されたキー要素の属性の名前と値の組を列挙する。
{#splitKey(String) splitKey}メソッドによって分割されたキー要素から 属性を取り出し、属性の名前と値の配列を列挙オブジェクトに格納して返す。

パラメータ:
keyElem - キー要素。
戻り値:
属性の名前と値の配列を格納した列挙オブジェクト。
例外:
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

splitKey

protected java.util.List<java.lang.String> splitKey(java.lang.String key)
                                             throws IllegalKeyException
キーを要素ごとに分割する。
分割する際にキーの書式の検証も行い、以下に反する場合に例外をスローする。

パラメータ:
key - キー。
例外:
IllegalKeyException - キーが不正な場合。

getPath

public java.lang.String getPath()
ロードしたリソースファイルのパスを取得する。
まだ一度もリソースファイルの読み込みを行っていない場合は、空文字列を返す。

戻り値:
ロードしたリソースファイルのパス。

load

public void load(java.lang.String path)
          throws java.io.FileNotFoundException,
                 java.io.IOException
指定されたパスのリソースファイルを読み込む。

パラメータ:
path - リソースファイルのパス。
例外:
java.io.FileNotFoundException - 指定されたパスのファイルが見つからなかった 場合。
java.io.IOException - ファイルの読み込み中に例外が発生した場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getInputStream

protected java.io.InputStream getInputStream(java.lang.String path)
                                      throws java.io.FileNotFoundException,
                                             java.io.IOException
指定されたパスから入力ストリームを取得する。

パラメータ:
path - リソースファイルのパス。
戻り値:
引数のパスに対する入力ストリーム。
例外:
java.io.FileNotFoundException - 指定されたパスのファイルが見つからなかった 場合。
java.io.IOException - 入力ストリームのオープン時に例外が発生した場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

load

protected abstract void load(java.io.InputStream stream)
                      throws java.io.IOException
引数の入力ストリームからリソースファイルの内容を読み込む。

パラメータ:
stream - 入力ストリーム。
例外:
java.io.IOException - 読み込み中に例外が発生した場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

save

public void save(java.lang.String path)
          throws java.io.IOException
指定されたパスのファイルに、このオブジェクトが保持している内容を保存する。

パラメータ:
path - 保存先のファイルのパス。
例外:
java.io.IOException - ファイルの保存中に例外が発生した場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getOutputStream

protected java.io.OutputStream getOutputStream(java.lang.String path)
                                        throws java.io.IOException
指定されたパスの出力ストリームを取得する。

パラメータ:
path - 保存先のファイルのパス。
戻り値:
引数のパスに対する出力ストリーム。
例外:
java.io.IOException - 指定されたパスのオープン時に例外が発生した場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

save

protected abstract void save(java.io.OutputStream stream)
                      throws java.io.IOException
引数の出力ストリームに、このオブジェクトが保持している内容を保存する。

パラメータ:
stream - 保存先の出力ストリーム。
例外:
java.io.IOException - ファイルの保存中に例外が発生した場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。


Copyright (C) SATOH Takayuki All Rights Reserved.