java.util
클래스 Properties

java.lang.Object 
  |
  +--java.util.Dictionary 
        |
        +--java.util.Hashtable 
              |
              +--java.util.Properties

모든 구현 인터페이스:

Cloneable , Map , Serializable

직계의 기존의 서브 클래스:

Provider

public class Properties

extends Hashtable

Properties 클래스는 불변의 프로퍼티 세트를 나타냅니다. Properties 를 스트림에 보관하거나 스트림으로부터 로드하거나 할 수가 있습니다. 프로퍼티 리스트의 각 키, 및 거기에 대응하는 값은 캐릭터 라인입니다.

프로퍼티 리스트에는 그 「디폴트 값」로서 다른 프로퍼티 리스트를 가질 수가 있습니다. 원의 프로퍼티 리스트로 프로퍼티 키가 발견되지 않으면 이 2 번째의 프로퍼티 리스트가 검색됩니다.

Properties 는 Hashtable 를 계승하므로,Properties 오브젝트에 대해서 put 메소드 및 putAll 메소드를 적용할 수 있습니다. 그러나, 이러한 메소드를 사용하는 것은 추천 되지 않습니다. 이러한 메소드를 사용하면(자), 호출 측에 키 또는 값이 String 가 아닌 엔트리를 삽입시키기 때문입니다. setProperty 메소드를 대신에 사용해 주세요. String 이외의 키 또는 값을 저장하는 「타협적」인 Properties 오브젝트로 store 메소드 또는 save 메소드가 불려 가면(자), 그 호출은 실패합니다.

프로퍼티를 스트림에 보존할 때, 또는 스트림으로부터 로드할 때, ISO 8859-1 캐릭터 인코딩이 사용됩니다. 이 인코딩에 직접 표시할 수 없는 캐릭터에는 Unicode escapes 가 사용됩니다. 다만, escape sequence에서는 1 캐릭터의 「u」만이 사용 가능합니다. 다른 캐릭터 인코딩과 프로퍼티 파일을 변환하는 경우, native2ascii 툴을 사용할 수 있습니다.

도입된 버젼:

JDK1. 0

관련 항목:

Solaris 용 native2ascii 툴, Windows 용 native2ascii 툴, 직렬화 된 형식

중첩된 클래스의 개요

클래스 java.util. Map 을 상속받은 중첩된 클래스

Map.Entry

필드의 개요

protected Properties

defaults 프로퍼티 리스트에 없는 키의 디폴트 값를 가지는 프로퍼티 리스트입니다.

생성자의 개요

Properties ()
디폴트 값를 가지지 않는 하늘의 프로퍼티 리스트를 작성합니다.

Properties (Properties defaults)
지정된 디폴트 값를 가지는 하늘의 프로퍼티 리스트를 작성합니다.

메소드의 개요

String	getProperty (String key) 지정된 키를 가지는 프로퍼티를, 프로퍼티 리스트로부터 찾습니다.
String	getProperty (String key, String defaultValue) 지정된 키를 가지는 프로퍼티를, 프로퍼티 리스트로부터 찾습니다.
void	list (PrintStream out) 지정된 출력 스트림에, 프로퍼티 리스트를 출력합니다.
void	list (PrintWriter out) 지정된 출력 스트림에, 프로퍼티 리스트를 출력합니다.
void	load (InputStream inStream) 입력 스트림으로부터 키와 요소가 대가 된 프로퍼티 리스트를 읽어들입니다.
Enumeration	propertyNames () 메인 프로퍼티 리스트에 같은 이름의 키가 발견되지 않는 경우는 디폴트의 프로퍼티 리스트에 있는 개별의 키를 포함한, 이 프로퍼티 리스트에 있는 모든 키의 리스트를 돌려줍니다.
void	save (OutputStream out, String header) 추천 되고 있지 않습니다. 이 메소드는 프로퍼티 리스트의 보존중에 입출력 에러가 발생해도 IOException 를 슬로우 하지 않습니다. Java 2 플랫폼 v1. 2 이후에서는 프로퍼티 리스트의 보존 방법으로서는 store(OutputStream out, String header) 메소드의 사용이 추천 됩니다.
Object	setProperty (String key, String value) Hashtable 의 put 메소드를 호출합니다.
void	store (OutputStream out, String header) Properties 테이블내의 프로퍼티 리스트 (키와 요소의 페어)를,load 메소드를 사용해 Properties 테이블에 로드하는데 적절한 포맷으로 출력 스트림에 기입합니다.

클래스 java.util. Hashtable 에서 상속받은 메소드

clear , clone , contains , containsKey , containsValue , elements , entrySet , equals , get , hashCode , isEmpty , keys , keySet , put , putAll , rehash , remove , size , toString , values

클래스 java.lang. Object 에서 상속받은 메소드

finalize , getClass , notify , notifyAll , wait , wait , wait

필드의 상세

defaults

protected Properties  defaults

프로퍼티 리스트에 없는 키의 디폴트 값를 가지는 프로퍼티 리스트입니다.

생성자의 상세

Properties

public Properties()

디폴트 값를 가지지 않는 하늘의 프로퍼티 리스트를 작성합니다.

Properties

public Properties(Properties  defaults)

지정된 디폴트 값를 가지는 하늘의 프로퍼티 리스트를 작성합니다.

파라미터:

defaults - 디폴트 값

메소드의 상세

setProperty

public Object  setProperty(String  key,
                          String  value)

Hashtable 의 put 메소드를 호출합니다. getProperty 메소드와 대가 됩니다. 프로퍼티의 키 및 값에 캐릭터 라인을 사용하는 것을 의무화 합니다. 돌려주어진 값은 put 에의 Hashtable 호출의 결과입니다

파라미터:

key - 프로퍼티 리스트에 배치되는 키

value - key 에 대응하는 값

반환값:

프로퍼티 리스트의 지정된 키의 전의 값. 그것이 없는 경우는 null

도입된 버젼:

1.2

관련 항목:

getProperty(java.lang.String)

load

public void load(InputStream  inStream)
          throws IOException 

입력 스트림으로부터 키와 요소가 대가 된 프로퍼티 리스트를 읽어들입니다. 스트림은 ISO 8859-1 캐릭터 인코딩을 사용하고 있다고 보입니다.

각 프로퍼티는 입력 스트림에 행 단위로 등록되어 있습니다. 각 행은 행 단락 캐릭터 (\n,\r, 또는 \r\n)로 끝납니다. 입력 스트림으로부터 읽어들인 행은 입력 스트림으로 파일의 마지막에 이를 때까지 처리됩니다.

공백 캐릭터만의 행, 또는 최초의 비공백 캐릭터가 ASCII 캐릭터 # 또는 ! 인 행은 무시됩니다. 즉,# 또는 ! (은)는 코멘트행을 나타냅니다.

공백행 또는 코멘트행 이외의 모든 행은 테이블에 추가되는 프로퍼티를 기술합니다. 다만, 행의 마지막이 \ 의 경우는 다음의 행이 있으면 계속행으로서 다루어집니다 (아래와 같이를 참조). 키는 최초의 비공백 캐릭터로부터, 최초의 ASCII 캐릭터 =,:, 또는 공백 캐릭터의 직전까지의, 은행내의 모든 캐릭터로부터 구성됩니다. 키의 마지막을 나타내는 캐릭터는 전에 \ 를 붙이는 것으로 키에 포함할 수도 있습니다. 키의 뒤의 공백은 모두 스킵 됩니다. 키의 뒤의 최초의 비공백 캐릭터가 = 또는 : 인 경우는 이러한 키는 무시되어 그 후의 공백 캐릭터도 모두 스킵 됩니다. 은행내의 그 이외의 캐릭터는 모두, 관련한 요소 캐릭터 라인의 일부가 됩니다. 요소 캐릭터 라인내에서는 ASCII escape sequence \t,\n,\r,\\,\",\',\ (엔기호와 스페이스), 및 \uxxxx 는 인식되어 단독의 캐릭터에 변환됩니다. 또, 행의 마지막 캐릭터가 \ 인 경우는 다음의 행은 현재의 행의 계속으로서 다루어집니다. 그 경우,\ 라고 행 단락 캐릭터가 파기되어 계속행의 선두에 공백이 있으면 그것도 모두 파기되어 요소 캐릭터 라인의 일부로는 되지 않습니다.

예를 들어, 다음의 4 행은 각각 키 Truth 와 관련한 요소치 Beauty 를 나타냅니다.

 Truth = Beauty
	Truth:Beauty
 Truth			:Beauty

또, 다음의 3 행은 1 개의 프로퍼티를 나타냅니다.

 fruits				apple, banana, pear, \
                                  cantaloupe, watermelon, \
                                  kiwi, mango

키는 fruits 로, 다음의 요소에 관련부 라고 있습니다.

"apple, banana, pear, cantaloupe, watermelon, kiwi, mango"

최종적인 결과로 콤마의 후에 반드시 스페이스가 표시되도록(듯이), 각 \ 의전에 스페이스가 있습니다. 행의 마지막을 나타내는 \ 과 계속행의 선두에 있는 공백은 파기되어 다른 캐릭터에 치환되지 않습니다.

또, 다음의 3 번째의 예에서는 키가 cheeses 로, 관련한 요소가 하늘의 캐릭터 라인인 것을 나타냅니다.

cheeses

키는 cheeses 로, 관련 요소는 하늘의 캐릭터 라인인 것을 지정하고 있습니다.

파라미터:

inStream - 입력 스트림

예외:

IOException - 입력 스트림으로부터 의 read중에 에러가 발생했을 경우

save

public void save(OutputStream  out,
                 String  header)

추천 되고 있지 않습니다. 이 메소드는 프로퍼티 리스트의 보존중에 입출력 에러가 발생해도 IOException 를 슬로우 하지 않습니다. Java 2 플랫폼 v1. 2 이후에서는 프로퍼티 리스트의 보존 방법으로서는 store(OutputStream out, String header) 메소드의 사용이 추천 됩니다.

store(OutputStream out, String header) 메소드를 호출하는 것으로, 슬로우 된 IOExceptions 를 억제합니다.

파라미터:

out - 출력 스트림

header - 프로퍼티 리스트의 기술

예외:

ClassCastException - 이 Properties 오브젝트에,String 가 아닌 키 또는 값이 저장되고 있는 경우

store

public void store(OutputStream  out,
                  String  header)
           throws IOException 

Properties 테이블내의 프로퍼티 리스트 (키와 요소의 페어)를,load 메소드를 사용해 Properties 테이블에 로드하는데 적절한 포맷으로 출력 스트림에 기입합니다. 스트림은 ISO 8859-1 캐릭터 인코딩을 사용해 기입해집니다.

Properties 테이블 (존재하는 경우)의 디폴트 테이블에서의 프로퍼티는 이 메소드에 따라서는 기입해지지 않습니다.

header 인수가 null 가 아닌 경우는 ASCII 캐릭터의 #, header 의 캐릭터 라인, 및 행 단락 캐릭터가 최초로 출력 스트림에 기입해집니다. 이 때문에,header 는 식별 코멘트로서 사용할 수 있습니다.

다음에, ASCII 캐릭터의 #, 현재의 일시 (Date 의 toString 메소드에 의해 현재 시각이 생성되는 것과 같이), 및 Writer 에 의해 생성되는 행 단락으로부터 되는 코멘트행이 기입해집니다.

계속되어,Properties 테이블내의 모든 엔트리가 1 행씩 써내집니다. 각 엔트리의 키 캐릭터 라인, ASCII 캐릭터의 =, 관련한 요소 캐릭터 라인이 기입해집니다. 요소 캐릭터 라인의 각 캐릭터는 escape sequence로서 표현 할 필요가 있을지 어떨지 확인됩니다. ASCII 캐릭터의 \, 탭, 개행, 및 복귀는 각각 \\,\t,\n, 및 \r 로서 기입해집니다. \u0020 보다 작은 캐릭터 및 \u007E 보다 큰 캐릭터는 대응하는 16 진치 xxxx 를 사용해 \uxxxx 로서 기입해집니다. 내장하기 공백 캐릭터에서도 뒷말 공백 캐릭터도 아닌 선행 공백 캐릭터는 전에 \ 를 붙여 기입해집니다. 키와 값의 캐릭터 #,! ,=, 및 : 은 반드시 올바르고 로드 되도록(듯이), 전에 slash를 붙여 기입해집니다.

엔트리가 기입해진 후에, 출력 스트림이 플래시 됩니다. 출력 스트림은 이 메소드로부터 복귀한 뒤도 연대로 입니다.

파라미터:

out - 출력 스트림

header - 프로퍼티 리스트의 기술

예외:

IOException - 이 프로퍼티 리스트를 지정한 출력 스트림에 기입해,IOException 가 슬로우 되었을 경우

ClassCastException - 이 Properties 오브젝트에,String 가 아닌 키 또는 값이 저장되고 있는 경우

NullPointerException - out 가 null 의 경우

도입된 버젼:

1.2

getProperty

public String  getProperty(String  key)

지정된 키를 가지는 프로퍼티를, 프로퍼티 리스트로부터 찾습니다. 그 키가 프로퍼티 리스트에 없으면 디폴트의 프로퍼티 리스트, 한층 더 그 디폴트 값가 반복해 조사할 수 있습니다. 그 프로퍼티가 발견되지 않는 경우는 null 가 돌려주어집니다.

파라미터:

key - 프로퍼티 키

반환값:

지정된 키치를 가지는 이 프로퍼티 리스트의 값

관련 항목:

setProperty(java.lang.String, java.lang.String) , defaults

getProperty

public String  getProperty(String  key,
                          String  defaultValue)

지정된 키를 가지는 프로퍼티를, 프로퍼티 리스트로부터 찾습니다. 그 키가 프로퍼티 리스트에 없으면 디폴트의 프로퍼티 리스트, 한층 더 그 디폴트 값가 반복해 조사할 수 있습니다. 그 프로퍼티가 발견되지 않는 경우는 디폴트 값의 인수가 돌려주어집니다.

파라미터:

key - 해시 테이블 키

defaultValue - 디폴트 값

반환값:

지정된 키치를 가지는 이 프로퍼티 리스트의 값

관련 항목:

setProperty(java.lang.String, java.lang.String) , defaults

propertyNames

public Enumeration  propertyNames()

메인 프로퍼티 리스트에 같은 이름의 키가 발견되지 않는 경우는 디폴트의 프로퍼티 리스트에 있는 개별의 키를 포함한, 이 프로퍼티 리스트에 있는 모든 키의 리스트를 돌려줍니다.

반환값:

프로퍼티 리스트에 있는 모든 키의 리스트. 디폴트의 프로퍼티 리스트에 있는 키를 포함한

관련 항목:

Enumeration , defaults

list

public void list(PrintStream  out)

지정된 출력 스트림에, 프로퍼티 리스트를 출력합니다. 이 메소드는 디버그에 편리합니다.

파라미터:

out - 출력 스트림

list

public void list(PrintWriter  out)

지정된 출력 스트림에, 프로퍼티 리스트를 출력합니다. 이 메소드는 디버그에 편리합니다.

파라미터:

out - 출력 스트림

도입된 버젼:

JDK1. 1