java.util
클래스 Properties

java.lang.Object 
  java.util.Dictionary <K, V>
      java.util.Hashtable <Object,
Object >
          java.util.Properties

모든 구현된 인터페이스:

Serializable, Cloneable, Map <Object, Object >

알려진 직계 서브 클래스:

Provider

public class Properties
extends Hashtable <Object,
Object >

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

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

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

load 및 store 메서드는 이하에 나타내는 간결한 행 지향의 포맷으로 프로퍼티를 로드 및 포함합니다. 이 포맷에서는 ISO 8859-1 문자 인코딩이 사용됩니다. 이 인코딩으로 직접 표현할 수 없는 문자는 Unicode 이스케이프를 사용해 기술할 수 있습니다. escape sequence로 사용할 수 있는 것은 단일의 문자 'u' 뿐입니다. native2ascii 툴을 사용하면, 프로퍼티 파일을 다른 문자 인코딩으로 변환하거나 그 역을 실행할 수 있습니다.

loadFromXML(InputStream) 및 storeToXML(OutputStream, String, String) 메서드는 프로퍼티를 단순한 XML 형식으로서 로드 및 포함할 수 있습니다. 디폴트에서는 UTF-8 문자 인코딩이 사용됩니다만, 필요에 따라서 인코딩을 지정할 수 있습니다. XML 프로퍼티 문서에서는 다음의 DOCTYPE 선언이 사용됩니다.

 <! DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
 

프로퍼티를 export/임포트 할 경우에 시스템 URI (http://java.sun.com/dtd/properties.dtd)에는 액세스 하지 않습니다. 시스템 URI는 DTD를 일의에 식별하는 캐릭터 라인으로서 사용됩니다. 그 내용은 다음과 같습니다.

    <? xml version="1.0" encoding="UTF-8"? >

    <! -- DTD for properties -->

    <! ELEMENT properties ( comment?, entry* ) >

    <! ATTLIST properties version CDATA #FIXED "1.0">

    <! ELEMENT comment (#PCDATA) >

    <! ELEMENT entry (#PCDATA) >

    <! ATTLIST entry key CDATA #REQUIRED>
 

도입된 버전 :

JDK1. 0

관련 항목:

native2ascii tool for Solaris, native2ascii tool for Windows, 직렬화 된 형식

필드 개요

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) 입력 스트림로부터 키와 요소가 대가 된 프로퍼티 리스트를 읽어들입니다.
void	loadFromXML (InputStream in) 지정된 입력 스트림상의 XML 문서에 의해 나타내지는 모든 프로퍼티를, 이 프로퍼티 테이블에 로드합니다.
Enumeration <? >	propertyNames () 메인 프로퍼티 리스트에 같은 이름의 키가 발견되지 않는 경우는 디폴트의 프로퍼티 리스트에 있는 개별의 키를 포함한, 이 프로퍼티 리스트에 있는 모든 키의 리스트를 리턴합니다.
void	save (OutputStream out, String comments) 추천하지 않습니다. 이 메서드는 프로퍼티 리스트의 보존중에 입출력 에러가 발생해도 IOException을 Throw 하지 않습니다. 프로퍼티 리스트의 보존 방법으로서는 store(OutputStream out, String comments) 메서드 또는 storeToXML(OutputStream os, String comment) 메서드의 사용이 추천 됩니다.
Object	setProperty (String key, String value) Hashtable put 메서드를 호출합니다.
void	store (OutputStream out, String comments) Properties 테이블내의 프로퍼티 리스트 (키와 요소의 페어)를, load 메서드를 사용해 Properties 테이블에 로드하는데 적절한 포맷으로 출력 스트림에 출력합니다.
void	storeToXML (OutputStream os, String comment) 이 테이블에 포함되는 모든 프로퍼티를 나타내는 XML 문서를 발행합니다.
void	storeToXML (OutputStream os, String comment, String encoding) 이 테이블에 포함되는 모든 프로퍼티를 나타내는 XML 문서를, 지정된 인코딩을 사용해 발행합니다.

클래스 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 문자 인코딩을 사용하고 있는 ( 각 바이트가 1개의 Latin1 문자이다)로 간주해집니다. Latin1 이외의 문자 및 일부의 특수 문자는 문자 및 캐릭터 라인 리터럴로 사용되는 escape sequence를 닮은 escape sequence를 사용해 키 및 요소내에서 표현할 수 있습니다 ( 「Java 언어 사양」의 §3. 3 및 §3. 10.6 을 참조). 문자 및 캐릭터 라인으로 사용되는 문자 escape sequence와의 차이는 다음과 같습니다.

• 8 진수의 이스케이프는 인식되지 않는다
• 문자 순서 \b는 백 스페이스 문자를 나타내지 않는다
• 이 메서드는 무효인 이스케이프 문자의 전의 backslash 문자 \를 에러로서 처리하지 않는다. backslash는 단지 삭제된다. 예를 들어 Java 캐릭터 라인에서는 순서 「\z」에 의해 컴파일시에 에러가 발생하는데 대해, 이 메서드는 단지 backslash를 삭제한다. 이 때문에 이 메서드에서는 2 문자의 순서 「\b」는 단일의 문자 「b」라고 등가이다고 보여진다
• 단일 인용부호 및 이중 인용부호에서는 이스케이프는 불필요하다. 다만, 전술의 규칙에 따라 backslash에 계속되는 단일 및 이중 인용부호 문자도, 각각 단일 인용부호 문자와 이중 인용부호 문자로서 처리된다

입력내에 부정한 Unicode 이스케이프가 존재하는 경우는 IllegalArgumentException가 발생 됩니다.

이 메서드는 행 단위로 입력을 처리합니다. 보통, 입력행의 마지막은 줄 끝 기호 (\n, \r, 또는 \r\n)세트 또는 파일의 마지막입니다. 자연행은 공백의 행이나 코멘트행인지, 키와 요소의 페어의 일부를 보관 유지하는 경우가 있습니다. backslash 문자 \를 사용해 줄 끝 기호 순서를 이스케이프 하는 것으로 키와 요소의 페어의 전데이터를 보관 유지하는 논리행이 인접하는 복수의 자연행에 걸치는 것이 가능하게 됩니다. 코멘트행을 이 방법으로 복수행에 걸치게 할 수 없습니다. 다음에 나타내도록, 코멘트를 포함한 자연행 마다 독자적인 코멘트 인디케이터(indicator)를 지정할 필요가 있습니다. 행은 파일의 마지막에 이를 때까지 입력 스트림로부터 읽힙니다.

공백 문자만을 포함한 자연행은 공백이라고 보여져 무시됩니다. 코멘트행에는 ASCII '#' 또는 '! '가 최초의 비공백 문자로서 포함됩니다. 코멘트행도 무시되어 키와 요소의 정보는 encode 되지 않습니다. 이 메서드는 줄 끝 기호에 더해스페이스 (' ', '\u0020'), 탭 ('\t', '\u0009') 및 form feed ('\f', '\u000C')도 공백으로서 처리합니다.

논리행이 복수의 자연행에 걸치는 경우, 줄 끝 기호 순서를 이스케이프 하는 backslash, 줄 끝 기호 순서 및 다음의 행의 선두의 공백 문자는 키 또는 요소의 값에 어떤 영향도 미치지 않습니다. 키와 요소의 구문 분석에 관한 나머지의 기술에서는 행 계속 문자가 삭제된 후에 키와 요소를 구성하는 모든 문자가 단일의 자연행에 표시되는 것을 전제로 해서 설명합니다. 줄 끝 기호가 이스케이프 되고 있는지를 확인하는 경우, 줄 끝 기호 순서의 전의 문자를 조사하는 것 만으로는 충분하지는 않습니다. 줄 끝 기호가 이스케이프 되기 위해서는 연속한 홀수의 backslash가 존재할 필요가 있습니다. 입력은 왼쪽에서 오른쪽으로 처리되기 때문에 줄 끝 기호의 전 (또는 다른 장소)에 제로가 아닌 연속한 backslash가 2n (짝수) 개존재하는 경우, 이스케이프 처리 후에 n개의 backslash가 encode 됩니다.

키에는 최초의 비공백 문자로부터, 최초의 이스케이프되어 있지 않은 '=', ':', 또는 공백 문자의 앞까지의 문자 모든 것 (줄 끝 기호를 제외하다)이 포함됩니다. 이것들 키의 마지막을 나타내는 문자는 모두, backslash를 앞에 두고 붙여 이스케이프 하는 것으로 키에 포함할 수 있습니다 . 예를 들어,

\:\=

에 는 2 문자의 키 「:=」이 포함됩니다. 줄 끝 기호는 escape sequence \r 및 \n을 사용해 포함할 수 있습니다 . 이 키의 뒤의 공백은 모두 스킵 됩니다. 이 키에 계속되는 최초의 비공백 문자가 '=' 또는 ':'인 경우, 이것은 무시되어 그 후의 공백 문자도 모두 스킵 됩니다. 행의 나머지의 문자는 모두, 관련된 요소 캐릭터 라인의 일부가 됩니다. 나머지의 문자가 존재하지 않는 경우, 요소는 비어있는 캐릭터 라인 ""가 됩니다. 키와 요소를 구성하는 원시문자 순서가 식별되면, 이스케이프 처리가 전술의 방법으로 실행됩니다.

예를 들어 다음의 3 행은 각각 키 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중에 에러가 발생했을 경우

IllegalArgumentException - 입력 스트림에 부정한 Unicode escape sequence가 포함되는 경우

save

@Deprecated 
public void save(OutputStream  out,
                            String  comments)

추천하지 않습니다. 이 메서드는 프로퍼티 리스트의 보존중에 입출력 에러가 발생해도 IOException을 Throw 하지 않습니다. 프로퍼티 리스트의 보존 방법으로서는 store(OutputStream out, String comments) 메서드 또는 storeToXML(OutputStream os, String comment) 메서드의 사용이 추천 됩니다.

store(OutputStream out, String comments) 메서드를 호출해, Throw 된 IOExceptions를 억제합니다.

파라미터:

out - 출력 스트림

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

예외:

ClassCastException - 이 Properties 객체에 String가 아닌 키 또는 값이 포함되고 있는 경우

store

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

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

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

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

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

계속되어, Properties 테이블내의 모든 엔트리가 1 행씩 써내집니다. 각 엔트리의 키 캐릭터 라인, ASCII 문자의 =, 관련한 요소 캐릭터 라인이 출력해집니다. 키 및 요소 캐릭터 라인의 각 문자는 escape sequence로서 렌더링 할 필요가 있을지 어떨지 확인됩니다. ASCII 문자의 \, 탭, form feed, 개행 및 복귀는 각각 \\, \t, \f, \n 및 \r로 서 출력해집니다. \u0020 보다 작은 문자 및 \u007E 보다 큰 문자는 적절한 16 진수 xxxx를 사용해 \uxxxx 로서 출력해집니다. 키의 경우, 모든 공백 문자는 전에 \ 문자를 붙여 출력해집니다. 요소의 경우, 매입 공백 문자에서도 뒷말 공백 문자도 아닌 선행 공백 문자는 전에 \를 붙여 출력해집니다. 키와 요소의 문자 #, ! , = 및 : 은 반드시 올바르고 로드 되도록, 전에 backslash를 붙여 출력해집니다.

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

파라미터:

out - 출력 스트림

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

예외:

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

ClassCastException - 이 Properties 객체에 String가 아닌 키 또는 값이 포함되고 있는 경우

NullPointerException - out이 null인 경우

도입된 버전 :

1.2

loadFromXML

public void loadFromXML(InputStream  in)
                 throws IOException,

                        InvalidPropertiesFormatException 

지정된 입력 스트림상의 XML 문서에 의해 나타내지는 모든 프로퍼티를, 이 프로퍼티 테이블에 로드합니다.

XML 문서에는 다음의 DOCTYPE 선언이 필요합니다.

 <! DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
 

게다가 문서는 전술의 프로퍼티 DTD를 채울 필요가 있습니다.

지정된 스트림은 이 메서드가 복귀한 뒤도 연대로 입니다.

파라미터:

in - XML 문서의 읽을 입력 스트림

예외:

IOException - 지정된 입력 스트림을 읽어들였을 때에 IOException이 발생했을 경우

InvalidPropertiesFormatException - 입력 스트림의 데이터에의해 요구된 문서형을 가지는 유효한 XML 문서가 작성되지 않았던 경우

NullPointerException - in가 null인 경우

도입된 버전 :

1.5

관련 항목:

storeToXML(OutputStream, String, String)

storeToXML

public void storeToXML(OutputStream  os,
                       String  comment)
                throws IOException 

이 테이블에 포함되는 모든 프로퍼티를 나타내는 XML 문서를 발행합니다.

이 메서드를 props.storeToXML(os, comment) 형식에서 호출했을 경우, props.storeToXML(os, comment, "UTF-8"); 호출과 같은 결과를 얻을 수 있습니다.

파라미터:

os - XML 문서의 발행처의 출력 스트림

comment - 프로퍼티 리스트의 설명. 코멘트가 불필요한 경우는 null

예외:

IOException - 지정된 출력 스트림에 출력했을 때에 IOException이 발생했을 경우

NullPointerException - os가 null인 경우

도입된 버전 :

1.5

관련 항목:

loadFromXML(InputStream)

storeToXML

public void storeToXML(OutputStream  os,
                       String  comment,
                       String  encoding)
                throws IOException 

이 테이블에 포함되는 모든 프로퍼티를 나타내는 XML 문서를, 지정된 인코딩을 사용해 발행합니다.

이 XML 문서에서는 다음의 DOCTYPE가 선언됩니다.

 <! DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
 

지정된 코멘트가 null인 경우, 문서에 코멘트는 포함되지 않습니다.

지정된 스트림은 이 메서드가 복귀한 뒤도 연대로 입니다.

파라미터:

os - XML 문서의 발행처의 출력 스트림

comment - 프로퍼티 리스트의 설명. 코멘트가 불필요한 경우는 null

예외:

IOException - 지정된 출력 스트림에 출력했을 때에 IOException이 발생했을 경우

NullPointerException - os가 null, 또는 encoding가 null인 경우

도입된 버전 :

1.5

관련 항목:

loadFromXML(InputStream)

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