jp.co.intra_mart.product.collaboration.icalendar.model.property

クラス PropertyBase

java.lang.Object

jp.co.intra_mart.product.collaboration.icalendar.model.property.PropertyBase

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

Serializable, IContentLine, IProperty

直系の既知のサブクラス:

Property

public abstract class PropertyBase
extends Object
implements IProperty

プロパティの基底モデルです。

コンテンツラインの入出力処理を実装します。

導入されたバージョン:

8.0.8

バージョン:

8.0.8

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PropertyBase() コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
abstract String	getParamString() プロパティパラメータの文字列を取得します。
abstract String	getValueString() プロパティ値の文字列を取得します。
String	name() プロパティ名を取得します。
boolean	read(IacICalendarReader reader) プロパティ情報を読み取ります。
abstract void	setParamString(String paramString) プロパティパラメータの文字列を解析して値を設定します。
abstract void	setValueString(String valueString) プロパティ値の文字列を解析して値を設定します。
String	toString() 文字列表現を取得します。
void	write(IacICalendarWriter writer) プロパティ情報を出力します。

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

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

インタフェースから継承されたメソッド jp.co.intra_mart.product.collaboration.icalendar.model.IContentLine

hasValue

コンストラクタの詳細

PropertyBase

public PropertyBase()

コンストラクタ

メソッドの詳細

getParamString

public abstract String getParamString()

プロパティパラメータの文字列を取得します。

戻り値:

プロパティパラメータの文字列

getValueString

public abstract String getValueString()

プロパティ値の文字列を取得します。

戻り値:

プロパティ値の文字列

name

public String name()

インタフェースからコピーされた説明: IProperty

プロパティ名を取得します。

定義:

name インタフェース内 IProperty

戻り値:

プロパティ名

read

public boolean read(IacICalendarReader reader)
             throws IacICalendarIOException

プロパティ情報を読み取ります。

プロパティ名が一致する場合のみ読取処理を行います。
以下の処理を行います。

• setParamString(String): プロパティパラメータの文字列解析、インスタンス生成および値の設定
• setValueString(String): プロパティ値の文字列解析、インスタンス生成および値の設定

先にプロパティパラメータの処理が行われるため、プロパティ値の処理においてプロパティパラメータを参照することが可能です。

定義:

read インタフェース内 IProperty

パラメータ:

reader - リーダー

戻り値:

処理結果（true:読取処理完了／false:読取処理なし）

例外:

IacICalendarIOException - 読取処理に失敗した場合

setParamString

public abstract void setParamString(String paramString)

プロパティパラメータの文字列を解析して値を設定します。

パラメータ:

paramString - プロパティパラメータの文字列

setValueString

public abstract void setValueString(String valueString)

プロパティ値の文字列を解析して値を設定します。

パラメータ:

valueString - プロパティ値の文字列

toString

public String toString()

文字列表現を取得します。

以下の各文字列を組み合わせて生成します。

• プロパティ名 (name) : プロパティモデルクラスに設定されたコンテンツライン情報アノテーション ContentLineInfo#name() 値
• プロパティパラメータ値 (param) : getParamString() 返却値
• プロパティ値 (value) : getValueString() 返却値

生成される文字列のパターンは以下のとおりです。
プロパティパラメータ値が null もしくは空・空白の場合はパラメータ部を付加しません。

• name + Constants.PARAM_SEPARATOR + param + Constants.SEPARATOR + value
• name + Constants.SEPARATOR + value

なお、プロパティ名およびプロパティ値は null / 空チェックを行わずにそのまま連結します。

オーバーライド:

toString クラス内 Object

戻り値:

文字列表現

関連項目:

Object.toString()

write

public void write(IacICalendarWriter writer)
           throws IacICalendarIOException

プロパティ情報を出力します。

以下の各文字列を組み合わせて生成した文字列を出力します。

• プロパティ名 (name) : プロパティモデルクラスに設定されたコンテンツライン情報アノテーション ContentLineInfo#name() 値
• プロパティパラメータ値 (param) : getParamString() 返却値
• プロパティ値 (value) : getValueString() 返却値

生成される文字列のパターンは以下のとおりです。
プロパティパラメータ値が null もしくは空・空白の場合はパラメータ部を付加しません。

• name + Constants.PARAM_SEPARATOR + param + Constants.SEPARATOR + value
• name + Constants.SEPARATOR + value

なお、以下の場合は出力を行いません。

• ライターが null の場合
• このプロパティが有効な値を保持していない場合（IContentLine.hasValue() == false）
• コンテンツライン情報が取得できなかった場合
• プロパティ名が null もしくは空・空白の場合

定義:

write インタフェース内 IProperty

パラメータ:

writer - ライター

例外:

IacICalendarIOException - 出力処理に失敗した場合

関連項目:

IContentLine.hasValue(), IacICalendarWriter.writeLine(String)