パッケージ org.opengion.fukurou.util

# クラス HybsEntry

java.lang.Object
org.opengion.fukurou.util.HybsEntry

すべての実装されたインタフェース:
  `Comparable<HybsEntry>`

public final class HybsEntry extends Object implements Comparable<HybsEntry>
HybsEntry.java は、内部に final 定義された文字列の、key と value を持つ、値クラスです。 全変数は、public final 宣言されており、外部より取得できますが、設定できません。 このクラスは、コンストラクタで設定されたキーと設定値を変える事が出来ません。 よって、デフォルトコンストラクタを持たないため、java.io.Serializable インターフェースは 持ちません。また、内部の値を変更できない為、clone() をする必要がないため、 java.lang.Cloneable インターフェースも実装していません。 HybsEntry オブジェクトの同一性を確保するには、equals( Object ) と、hashCode() メソッドを オーバーライドしておく必要があります。同一性の条件は、key と value が、ともに String.equals の関係を持てば、成立することとします。

導入されたバージョン:
  JDK5.0,

- ## コンストラクタの概要

  コンストラクタ
  コンストラクタ
  説明
  `HybsEntry(String key, String value)`
  コンストラクタ 内部変数への値の設定は、このコンストラクターで行われます。
  `HybsEntry(String key, String value, String comment)`
  コンストラクタ 内部変数への値の設定は、このコンストラクターで行われます。

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `int`
  `compareTo(HybsEntry other)`
  自然比較メソッド インタフェース Comparable の 実装です。
  `boolean`
  `equals(Object object)`
  このオブジェクトと他のオブジェクトが等しいかどうかを示します。
  `String`
  `getComment()`
  エントリに対応するコメントを返します。
  `String`
  `getKey()`
  エントリに対応するキーを返します。
  `String`
  `getValue()`
  エントリに対応する値を返します。
  `HybsEntry`
  `getValue(String newValue)`
  HybsEntry の設定されている値を変更します。
  `int`
  `hashCode()`
  オブジェクトのハッシュコード値を返します。
  `String`
  `toString()`
  オブジェクトの識別子として，詳細なユーザー情報を返します。

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

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- ## コンストラクタの詳細

  - ### HybsEntry

    public HybsEntry(String key, String value)
    コンストラクタ 内部変数への値の設定は、このコンストラクターで行われます。 key への null セットは認められません。value へは、セットできます。 コメントは、ゼロ文字列("") で、初期化されます。
    パラメータ:
      `key` - キー
      `value` - 値
    例外:
      `IllegalArgumentException` - key に null がセットされた場合

  - ### HybsEntry

    public HybsEntry(String key, String value, String comment)
    コンストラクタ 内部変数への値の設定は、このコンストラクターで行われます。 key への null セットは認められません。value へは、セットできます。
    パラメータ:
      `key` - キー
      `value` - 値
      `comment` - コメント
    例外:
      `IllegalArgumentException` - key に null がセットされた場合

- ## メソッドの詳細

  - ### getKey

    public String getKey()
    エントリに対応するキーを返します。
    戻り値:
      エントリに対応するキー

  - ### getValue

    public String getValue()
    エントリに対応する値を返します。
    戻り値:
      エントリに対応する値

  - ### getComment

    public String getComment()
    エントリに対応するコメントを返します。
    戻り値:
      エントリに対応するコメント

  - ### getValue

    public HybsEntry getValue(String newValue)
    HybsEntry の設定されている値を変更します。 これは、設定値を変更した新しい HybsEntry を作成して返します。 なお、value が、内部の値と等しい時(equals が成立する時)自分自身を返します。
    パラメータ:
      `newValue` - 新しい値
    戻り値:
      エントリー HybsEntry
    このﾒｿｯﾄﾞは、nullを返しません

  - ### compareTo

    public int compareTo(HybsEntry other)
    自然比較メソッド インタフェース Comparable の 実装です。 HybsEntryの順序は、key の順序であらわされます。 同一keyの場合は，value の順番になります。
    定義:
      `compareTo` インタフェース内 `Comparable<HybsEntry>`
    パラメータ:
      `other` - 比較対象のObject
    戻り値:
      このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数
    例外:
      `ClassCastException` - 指定されたオブジェクトがキャストできない場合。

  - ### equals

    public boolean equals(Object object)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。 インタフェース Comparable の 実装に関連して、再定義しています。 HybsEntryは、key が等しく、かつ valueが同一の場合に、 等しいと判断されます。
    オーバーライド:
      `equals` クラス内 `Object`
    パラメータ:
      `object` - 比較対象の参照オブジェクト
    戻り値:
      引数に指定されたオブジェクトとこのオブジェクトが等しい場合は true、そうでない場合は false

  - ### hashCode

    public int hashCode()
    オブジェクトのハッシュコード値を返します。 このメソッドは、java.util.Hashtable によって提供されるような ハッシュテーブルで使用するために用意されています。 equals( Object ) メソッドをオーバーライトした場合は、hashCode() メソッドも 必ず 記述する必要があります。 ここでは、key と value の合成した文字列のハッシュコード値を返します。
    オーバーライド:
      `hashCode` クラス内 `Object`
    戻り値:
      このオブジェクトのハッシュコード値

  - ### toString

    public String toString()
    オブジェクトの識別子として，詳細なユーザー情報を返します。
    オーバーライド:
      `toString` クラス内 `Object`
    戻り値:
      詳細なユーザー情報
    このﾒｿｯﾄﾞは、nullを返しません