org.opengion.fukurou.util

## クラス Options

- java.lang.Object
- - org.opengion.fukurou.util.Options

-     public final class Options
      extends Object

       Options.java は、String 型リストをプールするクラスです。

       HTMLのOptionタグのように、複数の文字列をキープしておき、
       すべてを連結して出力するような場合に利用できます。

       この実装は同期化されません。

  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

    コンストラクタ
    コンストラクタと説明
    `Options()` デフォルトコンストラクター

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `add(String value)` リストの末尾に指定の文字列を追加します。
    `void` | `clear()` すべての要素をリストから削除します 。
    `String` | `get(int index)` リスト内の指定された位置にある要素を返します。
    `String` | `getOption()` リストに含まれているデータを オプションタグ形式で返します。
    `String` | `getOption(boolean flag)` リストに含まれているデータを オプションタグ形式で返します。
    `int` | `size()` 登録されているオプションの数を返します。
    `String[]` | `toArray()` リスト内のすべての要素を正しい順序で保持する配列を返します。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

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

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

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

    - #### Options

          public Options()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### clear

          public void clear()

      すべての要素をリストから削除します 。 この呼び出しからの復帰後、リストは空になります 。 (例外をスローした場合を除く)。

    - #### add

          public void add(String value)

      リストの末尾に指定の文字列を追加します。 value が null の場合は､追加されません。
      パラメータ:
        `value` - リストに追加される文字列

    - #### get

          public String get(int index)

      リスト内の指定された位置にある要素を返します。 ただし、value が null の場合は、追加されていませんので、 index の順番と 登録データの順番が異なる場合もありますので､ 注意する必要があります。
      パラメータ:
        `index` - 返される要素のインデックス
      戻り値:
        リスト内の指定された位置にある要素

    - #### size

          public int size()

      登録されているオプションの数を返します。
      戻り値:
        インタフェース List 内の size

    - #### toArray

          public String[] toArray()

      リスト内のすべての要素を正しい順序で保持する配列を返します。
      戻り値:
        リスト内のすべての要素の配列
      このメソッドは、nullを返しません

    - #### getOption

          public String getOption()

      リストに含まれているデータを オプションタグ形式で返します。 各オプションタグは整形します。(各リスト毎に改行を入れます。)
      戻り値:
        Optionタグの形式で返します
      このメソッドは、nullを返しません

    - #### getOption

          public String getOption(boolean flag)

      リストに含まれているデータを オプションタグ形式で返します。 各オプションタグの整形をする／しないは、パラメータで指定します。
      パラメータ:
        `flag` - 整形する(true)／整形しない(false)
      戻り値:
        Optionタグの形式で返します
      このメソッドは、nullを返しません

    - #### toString

          public String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `Object`
      戻り値:
        オブジェクトの文字列表現

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.