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 에 있습니다. 빈 상태(empty)의 이름에는 컴퍼넌트는 없습니다.

이 인터페이스의 메소드에서는, 이름 또는 이름 컴퍼넌트인 파라미터의 유효한 값으로 해서 null 는 허용 되지 않습니다. 같이 이름 또는 이름 컴퍼넌트를 돌려주는 메소드에서는, null 는 돌려주어지지 않습니다.

Name 의 인스턴스는, 액세스가 읽어들여 전용이 아닌 경우, 병행 multi-thread 액세스에 대해서는 동기화 되지 않는 것이 있습니다.

도입된 버젼:

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) 이 이름이 지정한 접미사(suffix)로 종료할까를 판단합니다.
String	get (int posn) 이 이름의 컴퍼넌트를 가져옵니다.
Enumeration <String >	getAll () 이 이름의 컴퍼넌트를, 캐릭터 라인의 열거로서 가져옵니다.
Name	getPrefix (int posn) 컴퍼넌트가 이 이름의 컴퍼넌트의 접두사로 구성되는 이름을 작성합니다.
Name	getSuffix (int posn) 컴퍼넌트가 이 이름의 컴퍼넌트의 접미사(suffix)을 구성하는 이름을 작성합니다.
boolean	isEmpty () 이 이름이 빈 상태(empty)인지를 판정합니다.
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 개의 이름을 비교할 것은 없습니다.

정의:

인터페이스 Comparable <Object > 내의 compareTo

파라미터:

obj - 비교되는 null 이외의 객체

반환값:

이 이름이 지정된 이름보다 작은 경우는 부의 정수, 동일한 경우는 0, 큰 경우는 정의 정수

예외:

ClassCastException - obj 가 이 이름이라고 비교되는 형태 의 Name 가 아닌 경우

관련 항목:

Comparable.compareTo(Object)

size

int size()

이 이름의 컴퍼넌트수를 돌려줍니다.

반환값:

이 이름의 컴퍼넌트수

isEmpty

boolean isEmpty()

이 이름이 빈 상태(empty)인지를 판정합니다. 빈 상태(empty)의 이름은, 컴퍼넌트가 제로의 이름입니다.

반환값:

이 이름이 빈 상태(empty)의 경우는 true, 그렇지 않은 경우는 false

getAll

Enumeration <String > getAll()

이 이름의 컴퍼넌트를, 캐릭터 라인의 열거로서 가져옵니다. 이 이름에 갱신하는 것에 의한 열거에의 영향에 대해서는, 정의되고 있지 않습니다. 이름의 컴퍼넌트가 제로의 경우는, 빈 상태(empty)의 (null 이외의) 열거가 돌려주어집니다.

반환값:

이 이름의 컴퍼넌트의 열거, 각각은 캐릭터 라인

get

String  get(int posn)

이 이름의 컴퍼넌트를 가져옵니다.

파라미터:

posn - 취득하는 컴퍼넌트의 0 으로부터 시작되는 인덱스. 범위는 [0, size()] 가 아니면 안된다

반환값:

인덱스의 컴퍼넌트

예외:

ArrayIndexOutOfBoundsException - 위치가 지정한 범위에 없는 경우

getPrefix

Name  getPrefix(int posn)

컴퍼넌트가 이 이름의 컴퍼넌트의 접두사로 구성되는 이름을 작성합니다. 그 후 이 이름을 변경해도, 반환되는 이름에는 영향을 주지 않습니다. 또 역의 경우도 같습니다.

파라미터:

posn - 정지하는 컴퍼넌트의 0 으로부터 시작되는 인덱스. 범위는 [0, size()] 가 아니면 안된다

반환값:

범위가 [0, posn] 의 인덱스로 컴퍼넌트를 구성하는 이름

예외:

ArrayIndexOutOfBoundsException - 위치가 지정한 범위에 없는 경우

getSuffix

Name  getSuffix(int posn)

컴퍼넌트가 이 이름의 컴퍼넌트의 접미사(suffix)을 구성하는 이름을 작성합니다. 그 후 이 이름을 변경해도, 반환되는 이름에는 영향을 주지 않습니다. 또 역의 경우도 같습니다.

파라미터:

posn - 개시하는 컴퍼넌트의 0 으로부터 시작되는 인덱스. 범위는 [0, size()] 가 아니면 안된다

반환값:

범위가 [posn, size()] 의 인덱스로 컴퍼넌트를 구성하는 이름 위치가 size()와 동일한 경우는, 빈 상태(empty)의 이름이 반환된다

예외:

ArrayIndexOutOfBoundsException - 위치가 지정한 범위에 없는 경우

startsWith

boolean startsWith(Name  n)

이 이름이 지정한 접두사로 개시될까를 판단합니다. 이름 n 는,getPrefix(n.size()) 와 동일한 경우의 접두사입니다.

파라미터:

n - 체크 대상의 이름

반환값:

n 가 이 이름의 접두사인 경우는 true, 그렇지 않은 경우는 false

endsWith

boolean endsWith(Name  n)

이 이름이 지정한 접미사(suffix)로 종료할까를 판단합니다. 이름 n 는,getSuffix(size() -n.size()) 와 동일한 경우의 접미사(suffix)입니다.

파라미터:

n - 체크 대상의 이름

반환값:

n 가 이 이름의 접미사(suffix)인 경우는 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 - 위치가 지정한 범위에 없는 경우

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 - 위치가 지정한 범위에 없는 경우

InvalidNameException - comp 의 추가가 이 이름의 구문 규칙에 위반하는 경우

remove

Object  remove(int posn)
              throws InvalidNameException 

이 이름으로부터 컴퍼넌트를 삭제합니다. 지정한 위치에 있는 이 이름의 컴퍼넌트가 삭제됩니다. 이 정도치보다 큰 인덱스의 컴퍼넌트는, 1 개(살)하 (인덱스 0 (분)편에)에 이동됩니다.

파라미터:

posn - 삭제하는 컴퍼넌트의 인덱스. 범위는 [0, size()] 가 아니면 안된다

반환값:

삭제된 컴퍼넌트 (String)

예외:

ArrayIndexOutOfBoundsException - 위치가 지정한 범위에 없는 경우

InvalidNameException - 컴퍼넌트의 삭제가 이 이름의 구문 규칙에 위반하는 경우