javax.naming
介面 Name

所有父級介面：

Cloneable, Comparable<Object>, Serializable

所有已知實作類別：

CompositeName, CompoundName, LdapName

public interface Name
extends Cloneable, Serializable, Comparable<Object>

Name 介面表示一個一般名稱，即一個有序的元件序列。該名稱可以是一個復合名稱（跨多個名稱空間的名稱），或是一個組合名稱（在各個分層的命名系統中使用的名稱）。

可以有不同的 Name 實作；例如，復合名稱、URL 或特定於名稱空間的組合名稱。

名稱的元件都已編號。帶 N 個元件的名稱的索引在 0 到 N（但不包括 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)

比較此名稱與另一個名稱的順序。根據此名稱小於、等於還是大於給定名稱分別返回負整數、零或正整數。

對於 Object.equals()，名稱排序的概念取決於實作此介面的類別。例如，該排序可能基於名稱元件的字典順序進行。該名稱的特定屬性（比如對待大小寫的方式）可能影響排序。通常，無法比較兩個不同類別的名稱。

指定者：

介面 Comparable<Object> 中的 compareTo

參數：

obj - 要與之比較的非 null 物件。

返回：

根據此名稱小於、等於還是大於給定名稱分別返回負整數、零或正整數

拋出：

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()) 內。

返回：

索引 posn 處的元件

拋出：

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()) 之間的元件組成的名稱。如果 posn 等於 size()，則返回一個空名稱。

拋出：

ArrayIndexOutOfBoundsException - 如果 posn 超出指定範圍

startsWith

boolean startsWith(Name n)

確定此名稱是否從某一指定前綴開始。如果該方法與 getPrefix(n.size()) 等效，則名稱 n 是一個前綴。

參數：

n - 要檢查的名稱

返回：

如果 n 是此名稱的前綴，則返回 true，否則返回 false

endsWith

boolean endsWith(Name n)

確定此名稱是否以某一指定後綴結束。如果該方法與 getSuffix(size()-n.size()) 等效，則名稱 n 是一個後綴。

參數：

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

在此名稱中的指定位置添加單個元件。此名稱位於新元件索引處或這之後的元件被上移（遠離索引 0）一位，以容納新元件。

參數：

comp - 要添加的元件

posn - 將在其所在位置處添加新元件的索引。該索引必須在範圍 [0,size()] 內。

返回：

更新的名稱（不是新名稱）

拋出：

ArrayIndexOutOfBoundsException - 如果 posn 超出指定範圍

InvalidNameException - 如果添加 comp 將違反此名稱的語法規則

remove

Object remove(int posn)
              throws InvalidNameException

從此名稱中移除一個元件。移除此名稱位於指定位置處的元件。索引大於此位置的元件都被下移（朝向索引 0）一位。

參數：

posn - 要移除的元件的索引。該索引必須在範圍 [0,size()) 內。

返回：

移除的元件（一個 String）

拋出：

ArrayIndexOutOfBoundsException - 如果 posn 超出指定範圍

InvalidNameException - 如果刪除元件將違反該名稱的語法規則