モジュール java.naming
パッケージ javax.naming

インタフェースName

  • すべてのスーパー・インタフェース:
    Cloneable, Comparable<Object>, Serializable
    既知のすべての実装クラス:
    CompositeName, CompoundName, LdapName

    public interface Name
    extends Cloneable, Serializable, Comparable<Object>
    Nameインタフェースは、一般名、つまりコンポーネントが順序付けされたシーケンスを表します。 合成名(複数の名前空間にまたがる名前)、または複合名(個別の階層ネーミング・システムで使用される名前)を指定できます。

    Nameにはほかの実装もあります。たとえば、合成名、URL、または名前空間に固有の複合名などです。

    名前のコンポーネントには、番号が付けられます。 Nコンポーネントの名前のインデックスは、0からN未満の範囲で番号が付けられます。 この範囲は、[0,N]と表されます。 もっとも重要なコンポーネントは、インデックス0にあります。 空の名前にはコンポーネントはありません。

    このインタフェースのメソッドでは、名前または名前コンポーネントであるパラメータの有効な値としてnullは許容されません。 同様に、名前または名前コンポーネントを返すメソッドでは、nullは返されません。

    Nameのインスタンスは、アクセスが読込み専用ではない場合、並行マルチスレッド・アクセスに対しては同期化されないことがあります。

    導入されたバージョン:
    1.3
    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      static long serialVersionUID
      クラスのフィンガ・プリントを設定して、このクラスの前のバージョンとの互換性を直列化して表示します。
    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 抽象メソッド 
      修飾子と型 メソッド 説明
      Name add​(int posn, String comp)
      単一のコンポーネントを、この名前の指定した位置に追加します。
      Name add​(String comp)
      単一のコンポーネントをこの名前の最後に追加します。
      Name addAll​(int posn, Name n)
      名前のコンポーネントを、この名前の指定した位置に順に追加します。
      Name addAll​(Name suffix)
      名前のコンポーネントを、この名前の末尾に順に追加します。
      Object clone()
      この名前のコピーを生成します。
      int compareTo​(Object obj)
      この名前と別の名前の順序を比較します。
      boolean endsWith​(Name n)
      この名前が指定した接尾辞で終了するかを判断します。
      String get​(int posn)
      この名前のコンポーネントを取得します。
      Enumeration<String> getAll()
      この名前のコンポーネントを、文字列の列挙として取得します。
      Name getPrefix​(int posn)
      コンポーネントがこの名前のコンポーネントの接頭辞で構成される名前を作成します。
      Name getSuffix​(int posn)
      コンポーネントがこの名前のコンポーネントの接尾辞で構成される名前を作成します。
      boolean isEmpty()
      この名前が空かを判定します。
      Object remove​(int posn)
      この名前からコンポーネントを削除します。
      int size()
      この名前のコンポーネント数を返します。
      boolean startsWith​(Name n)
      この名前が指定した接頭辞で開始されるかを判断します。
    • フィールドの詳細

      • serialVersionUID

        static final long serialVersionUID
        クラスのフィンガ・プリントを設定して、このクラスの前のバージョンとの互換性を直列化して表示します。
        関連項目:
        定数フィールド値
    • メソッドの詳細

      • clone

        Object clone()
        この名前のコピーを生成します。 この名前のコンポーネントを後で変更しても、新しいコピーには影響しません。また逆の場合も同じです。
        戻り値:
        この名前のコピー
        関連項目:
        Object.clone()
      • compareTo

        int compareTo​(Object obj)
        この名前と別の名前の順序を比較します。 この名前が指定された名前より小さい場合は負の整数、等しい場合は0、大きい場合は正の整数をそれぞれ返します。

        Object.equals()の場合と同様に、名前の順序付けの概念は、このインタフェースを実装するクラスにより異なります。 たとえば、順序付けが、名前コンポーネントの辞書の順序付けに基づくことがあります。 大文字と小文字の区別など、名前の特定の属性が順序付けに影響することもあります。 通常、異なるクラスの2つの名前を比較することはありません。

        定義:
        compareTo、インタフェース: Comparable<Object>
        パラメータ:
        obj - 比較対象となるnull以外のオブジェクト。
        戻り値:
        この名前が指定された名前より小さい場合は負の整数、等しい場合は0、大きい場合は正の整数。
        例外:
        ClassCastException - objがこの名前と比較できる型のNameではない場合
        関連項目:
        Comparable.compareTo(Object)
      • size

        int size()
        この名前のコンポーネント数を返します。
        戻り値:
        この名前のコンポーネント数
      • isEmpty

        boolean isEmpty()
        この名前が空かを判定します。 空の名前は、コンポーネントがゼロの名前です。
        戻り値:
        この名前が空の場合はtrue、そうでない場合はfalse
      • getAll

        Enumeration<String> getAll()
        この名前のコンポーネントを、文字列の列挙として取得します。 この名前に更新することによる列挙への影響については、定義されていません。 名前のコンポーネントがゼロの場合は、空の(null以外の)列挙が返されます。
        戻り値:
        この名前のコンポーネントの列挙、それぞれは文字列
      • get

        String get​(int posn)
        この名前のコンポーネントを取得します。
        パラメータ:
        posn - 取得するコンポーネントの0から始まるインデックス。 範囲は[0,size()]でなければならない。
        戻り値:
        インデックスのコンポーネント
        例外:
        ArrayIndexOutOfBoundsException - posnが指定された範囲にない場合
      • getPrefix

        Name getPrefix​(int posn)
        コンポーネントがこの名前のコンポーネントの接頭辞で構成される名前を作成します。 その後この名前を変更しても、返される名前には影響しません。また逆の場合も同じです。
        パラメータ:
        posn - 停止する位置を示す、コンポーネントの0から始まるインデックス。 範囲は[0,size()]でなければならない。
        戻り値:
        範囲が[0,posn)のインデックスのコンポーネントで構成される名前。
        例外:
        ArrayIndexOutOfBoundsException - posnが指定された範囲にない場合
      • getSuffix

        Name getSuffix​(int posn)
        コンポーネントがこの名前のコンポーネントの接尾辞で構成される名前を作成します。 その後この名前を変更しても、返される名前には影響しません。また逆の場合も同じです。
        パラメータ:
        posn - 開始する位置を示す、コンポーネントの0から始まるインデックス。 範囲は[0,size()]でなければならない。
        戻り値:
        範囲が[posn,size())のインデックスのコンポーネントで構成される名前。 位置がsize()と等しい場合は、空の名前が返される。
        例外:
        ArrayIndexOutOfBoundsException - posnが指定された範囲にない場合
      • startsWith

        boolean startsWith​(Name n)
        この名前が指定した接頭辞で開始されるかを判断します。 名前nは、getPrefix(n.size())と等しい場合の接頭辞です。
        パラメータ:
        n - チェックする名前
        戻り値:
        nがこの名前の接頭辞である場合はtrue、そうでない場合はfalse
      • endsWith

        boolean endsWith​(Name n)
        この名前が指定した接尾辞で終了するかを判断します。 名前nは、getSuffix(size()-n.size())と等しい場合の接尾辞です。
        パラメータ:
        n - チェックする名前
        戻り値:
        nがこの名前の接尾辞である場合はtrue、そうでない場合はfalse
      • addAll

        Name addAll​(Name suffix)
             throws InvalidNameException
        名前のコンポーネントを、この名前の末尾に順に追加します。
        パラメータ:
        suffix - 追加するコンポーネント
        戻り値:
        更新された名前(新しい名前ではない)
        例外:
        InvalidNameException - suffixが有効な名前でない場合、またはコンポーネントの追加がこの名前の構文規則に違反する場合
      • addAll

        Name addAll​(int posn,
                    Name n)
             throws InvalidNameException
        名前のコンポーネントを、この名前の指定した位置に順に追加します。 最初の新しいコンポーネントのインデックス、またはその後ろにあるこの名前のコンポーネントは上(0から離れる)に移動され、新しいコンポーネントが調整されます。
        パラメータ:
        n - 追加するコンポーネント
        posn - 新しいコンポーネントを追加する位置を示す、この名前内のインデックス。 範囲は[0,size()]でなければならない。
        戻り値:
        更新された名前(新しい名前ではない)
        例外:
        ArrayIndexOutOfBoundsException - posnが指定された範囲にない場合
        InvalidNameException - nが有効な名前でない場合、またはコンポーネントの追加がこの名前の構文規則に違反する場合
      • add

        Name add​(String comp)
          throws InvalidNameException
        単一のコンポーネントをこの名前の最後に追加します。
        パラメータ:
        comp - 追加するコンポーネント
        戻り値:
        更新された名前(新しい名前ではない)
        例外:
        InvalidNameException - compの追加がこの名前の構文規則に違反する場合
      • add

        Name add​(int posn,
                 String comp)
          throws InvalidNameException
        単一のコンポーネントを、この名前の指定した位置に追加します。 新しいコンポーネントのインデックス、またはその後ろにあるこの名前のコンポーネントは1つ上(インデックス0から離れる)に移動され、新しいコンポーネントが調整されます。
        パラメータ:
        comp - 追加するコンポーネント
        posn - 新しいコンポーネントを追加するインデックス。 範囲は[0,size()]でなければならない。
        戻り値:
        更新された名前(新しい名前ではない)
        例外:
        ArrayIndexOutOfBoundsException - posnが指定された範囲にない場合
        InvalidNameException - compの追加がこの名前の構文規則に違反する場合
      • remove

        Object remove​(int posn)
               throws InvalidNameException
        この名前からコンポーネントを削除します。 指定した位置にあるこの名前のコンポーネントが削除されます。 この位置より大きいインデックスのコンポーネントは、1つ下(インデックス0の方に)に移動されます。
        パラメータ:
        posn - 削除するコンポーネントのインデックス。 範囲は[0,size()]でなければならない。
        戻り値:
        削除されたコンポーネント(String)
        例外:
        ArrayIndexOutOfBoundsException - posnが指定された範囲にない場合
        InvalidNameException - コンポーネントの削除がこの名前の構文規則に違反する場合