java.util
클래스 ResourceBundle

java.lang.Object 
  java.util.ResourceBundle

알려진 직계 서브 클래스:

ListResourceBundle, PropertyResourceBundle

public abstract class ResourceBundle
extends Object 

자원 번들에는 로케일 고유의 객체가 포함됩니다. 프로그램으로 String 등의 로케일 고유의 자원이 필요한 때는 사용자 의 로케일에 맞은 자원 번들로부터 로드할 수 있습니다. 이와 같이, 자원 번들로부터, 로케일 고유의 정보의 모두가 아니어도 그 대부분을 떼어내는 것으로 사용자 의 로케일에는 거의 존하지 않는 프로그램 코드를 쓸 수가 있습니다.

이것에 의해 다음의 특징을 가지는 프로그램을 쓰는 것이 가능하게 됩니다.

• 다른 언어에의 지역 대응, 또는 번역이 용이
• 복수의 로케일을 동시에 처리 가능
• 장래 지원하는 로케일을 추가할 때의 수정이 용이

자원 번들은 패밀리에 속하고 있습니다. 그 패밀리에서는 멤버는 공통의 기저명을 공유하고 있습니다만, 패밀리명에는 로케일을 식별하는 추가 컴퍼넌트도 포함되어 있습니다. 예를 들어 자원 번들의 패밀리의 기저명은 「MyResources」입니다. 패밀리는 패밀리와 같은 이름 (MyResources)으로 특정의 로케일이 지원 되지 않는 경우는 마지막 수단의 번들로서 사용되는 디폴트의 리소스반톨을 가질 필요가 있습니다. 또, 패밀리는 필요한 만큼의 수의 로케일 고유의 멤버를 제공할 수 있습니다 . 예를 들어 「MyResources_de」라고 이름이 붙여진 독일의 멤버 등입니다.

패밀리의 각 자원 번들에는 같은 항목이 있습니다만, 이러한 항목은 해당 자원 번들에 의해 나타내지는 로케일에 맞추어 번역되고 있습니다. 예를 들어 「MyResources」와「MyResources_de」의 양쪽 모두에 조작 취소용의 버튼에 사용되는 String가 포함되어 있는 경우는 「MyResources」에는 String에 「Cancel」가 「MyResources_de」에는 「Abbrechen」가 포함되어 있습니다.

같은 언어를 사용하는 로케일에서도 나라에 의해 자원이 다를 때는 특수화가 가능합니다. 예를 들어, MyResources_de_CH에는 스위스 (CH) 계의 독일어 (de)의 객체가 포함되어 있습니다. 자원의 일부만을 수정할 수도 있습니다.

프로그램으로 로케일 고유의 객체가 필요한 때는 getBundle 메서드를 사용해, ResourceBundle 클래스를 다음과 같이 로드합니다.

 ResourceBundle myResources =
      ResourceBundle.getBundle("MyResources", currentLocale);
 

자원 번들은 키와 값의 페어가 되어 있습니다. 키는 번들의 로케일 고유의 객체를 일의에 식별합니다. 키와 값의 2개의 페어가 포함되어 있는 ListResourceBundle 예를 나타냅니다.

 public class MyResources extends ListResourceBundle {
      public Object[][] getContents() {
              return contents;
      }
      static final Object[][] contents = {
      // LOCALIZE THIS
              {"OkKey", "OK"},
              {"CancelKey", "Cancel"},
      // END OF MATERIAL TO LOCALIZE
      };
 }
 

키는 항상 String 입니다. 이 예에서는 키는 OkKey와 CancelKey 입니다. 전술한 예에서는 값 「OK」와「Cancel」도 String 입니다만, 반드시 그런 필요는 없습니다. 값은 어느 형태의 객체에서도 가능합니다.

자원 번들로부터 적절한 getter 메서드를 사용해 객체를 검색합니다. 「OkKey」와「CancelKey」는 어느쪽이나 캐릭터 라인이므로 검색에는 getString를 사용합니다.

 button1 = new Button(myResources.getString("OkKey"));
 button2 = new Button(myResources.getString("CancelKey"));
 

getter 메서드는 모두 인수로서 키를 요구해, 검출한 객체를 리턴합니다. 객체가 발견되지 않는 경우, getter 메서드는 MissingResourceException을 Throw 합니다.

getString 이외에 ResourceBundle 에서는 캐릭터 라인 배열을 얻는 getStringArray 메서드도 제공합니다. 같이 다른 형태의 객체를 얻는 범용 getObject 메서드도 제공합니다. getObject를 사용하는 경우, 결과를 적절한 형태에 캐스트 할 필요가 있습니다. 다음에 예를 나타냅니다.

 int[] myIntegers = (int[]) myResources.getObject("intList");
 

Java 2 플랫폼에서는 ResourceBundle 2개의 서브 클래스 ListResourceBundle 및 PropertyResourceBundle가 준비되어 있습니다. 이것들은 자원을 작성꽤 간단한 방법을 제공합니다. 전의 예로 간단하게 가리킨 것처럼, ListResourceBundle는 그 자원을 키와 값의 페어의 리스트로서 관리합니다. PropertyResourceBundle는 프로퍼티 파일을 사용해 그 자원을 관리합니다.

ListResourceBundle 또는 PropertyResourceBundle로는 불충분한 때는 독자적인 ResourceBundle 서브 클래스를 쓸 수가 있습니다. 그러한 서브 클래스에서는 handleGetObject 메서드 및 getKeys() 메서드의 2개를 오버라이드(override) 할 필요가 있습니다.

다음에 있는 것은 ResourceBundle 서브 클래스 MyResources 매우 간단한 예입니다. 이 서브 클래스는 2개의 자원을 관리합니다 (서브 클래스가 다수의 자원을 관리하는 경우는 Hashtable을 사용한다). 「친레벨」의 ResourceBundle가 (아래와 같은 okKey와 같이) 같은 값을 가지는 같은 키를 취급하는 경우는 값을 제공할 필요는 없습니다.

례:

 // default (English language, United States)
 public class MyResources extends ResourceBundle {
     public Object handleGetObject(String key) {
         if (key.equals("okKey")) return "Ok";
         if (key.equals("cancelKey")) return "Cancel";
         return null;
     }
 }

 // German language
 public class MyResources_de extends MyResources {
     public Object handleGetObject(String key) {
         // don't need okKey, since parent level handles it.
         if (key.equals("cancelKey")) return "Abbrechen";
         return null;
     }
 }
 

ResourceBundle 싱글 패밀리의 사용을 제한할 필요는 없습니다. 예를 들어 예외 메세지 ExceptionResources (ExceptionResources_fr, ExceptionResources_de 등)로 1개의 자원, 위제트 WidgetResource (WidgetResources_fr, WidgetResources_de 등)로 1개의 자원과 같이, 좋아하는 대로 자원을 분할해 번들세트를 가질 수도 있습니다.

도입된 버전 :

JDK1. 1

관련 항목:

ListResourceBundle, PropertyResourceBundle, MissingResourceException

필드 개요

protected ResourceBundle

parent 이 번들의 친번들.

생성자 개요

ResourceBundle ()
유일한 생성자 입니다.

메서드 개요

static ResourceBundle	getBundle (String baseName) 지정된 기저명, 디폴트의 로케일 및 호출측의 클래스 로더를 사용해, 자원 번들을 취득합니다.
static ResourceBundle	getBundle (String baseName, Locale locale) 지정된 기저명, 로케일 및 호출측의 클래스 로더를 사용해, 자원 번들을 취득합니다.
static ResourceBundle	getBundle (String baseName, Locale locale, ClassLoader loader) 지정된 기저명, 로케일, 클래스 로더를 사용해, 자원 번들을 취득합니다.
abstract Enumeration <String >	getKeys () 키의 리스트를 리턴합니다.
Locale	getLocale () 자원 번들의 Locale를 리턴합니다.
Object	getObject (String key) 이 자원 번들 또는 그 친자원 번들의 어느쪽이든으로부터 지정된 키의 객체를 취득합니다.
String	getString (String key) 이 자원 번들 또는 그 친자원 번들의 어느쪽이든으로부터 지정된 키의 캐릭터 라인을 취득합니다.
String []	getStringArray (String key) 이 자원 번들 또는 그 친자원 번들의 어느쪽이든으로부터 지정된 키의 캐릭터 라인 배열을 취득합니다.
protected abstract Object	handleGetObject (String key) 이 자원 번들로부터 지정된 키의 객체를 취득합니다.
protected void	setParent (ResourceBundle parent) 이 번들의 친번들을 설정합니다.

클래스 java.lang. Object 로부터 상속된 메서드

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

필드의 상세

parent

protected ResourceBundle  parent

이 번들의 친번들. 친번들에 특정의 자원이 포함되지 않을 때는 getObject를 사용해 친번들을 검색합니다.

생성자 상세

ResourceBundle

public ResourceBundle()

유일한 생성자 입니다. 서브 클래스의 생성자에 한 호출은 일반적으로 암묵적인 호출입니다.

메서드의 상세

getString

public final String  getString(String  key)

이 자원 번들 또는 그 친자원 번들의 어느쪽이든으로부터 지정된 키의 캐릭터 라인을 취득합니다. 이 메서드를 호출하는 것은 다음을 호출하는 것과 같습니다.

(String) getObject (key)

파라미터:

key - 바람직한 캐릭터 라인의 키

반환값:

지정된 키의 캐릭터 라인

예외:

NullPointerException - key가 null인 경우

MissingResourceException - 지정된 키의 객체가 발견되지 않는 경우

ClassCastException - 지정된 키가 발견된 객체가 캐릭터 라인이 아닌 경우

getStringArray

public final String [] getStringArray(String  key)

이 자원 번들 또는 그 친자원 번들의 어느쪽이든으로부터 지정된 키의 캐릭터 라인 배열을 취득합니다. 이 메서드를 호출하는 것은 다음을 호출하는 것과 같습니다.

(String[]) getObject (key)

파라미터:

key - 바람직한 캐릭터 라인 배열의 키

반환값:

지정된 키의 캐릭터 라인 배열

예외:

NullPointerException - key가 null인 경우

MissingResourceException - 지정된 키의 객체가 발견되지 않는 경우

ClassCastException - 지정된 키가 발견된 객체가 캐릭터 라인 배열이 아닌 경우

getObject

public final Object  getObject(String  key)

이 자원 번들 또는 그 친자원 번들의 어느쪽이든으로부터 지정된 키의 객체를 취득합니다. 이 메서드는 최초로 handleGetObject를 사용해, 이 자원 번들로부터 객체를 취득하려고 합니다. 객체를 취득하지 못하고, 친자원 번들이 null이 아닌 경우, 부모의 getObject 메서드를 호출합니다. 그런데도 취득할 수 없는 경우는 MissingResourceException을 Throw 합니다.

파라미터:

key - 바람직한 객체의 키

반환값:

지정된 키의 객체

예외:

NullPointerException - key가 null인 경우

MissingResourceException - 지정된 키의 객체가 발견되지 않는 경우

getLocale

public Locale  getLocale()

자원 번들의 Locale를 리턴합니다. 이 메서드는 리턴된 자원 번들이 정말로 요구된 로케일에 대응하고 있는지, 또는 폴 백인지를 판정하기 위해서 getBundle()를 호출한 후에 사용할 수 있습니다.

반환값:

이 자원 번들의 로케일

setParent

protected void setParent(ResourceBundle  parent)

이 번들의 친번들을 설정합니다. 친번들은 이 번들에 특정의 자원이 포함되지 않을 때에 getObject 에 의해 참조됩니다.

파라미터:

parent - 이 번들의 친번들

getBundle

public static final ResourceBundle  getBundle(String  baseName)

지정된 기저명, 디폴트의 로케일 및 호출측의 클래스 로더를 사용해, 자원 번들을 취득합니다. 이 메서드를 호출하는 것은 다음을 호출하는 것과 같습니다.

getBundle(baseName, Locale.getDefault(), this.getClass(). getClassLoader())

getClassLoader()가 ResourceBundle 시큐러티 특권에 의해 실행되는 것만이 다릅니다. 검색과 인스턴스 생성 방법의 상세한 것에 대하여는 getBundle를 참조하십시오.

파라미터:

baseName - 자원 번들, 완전 지정된 클래스명의 기저명

반환값:

지정된 기저명과 디폴트의 로케일의 자원 번들

예외:

NullPointerException - baseName가 null인 경우

MissingResourceException - 지정된 기저명의 자원 번들이 발견되지 않는 경우

getBundle

public static final ResourceBundle  getBundle(String  baseName,
                                             Locale  locale)

지정된 기저명, 로케일 및 호출측의 클래스 로더를 사용해, 자원 번들을 취득합니다. 이 메서드를 호출하는 것은 다음을 호출하는 것과 같습니다.

getBundle(baseName, locale, this.getClass(). getClassLoader())

getClassLoader()가 ResourceBundle 시큐러티 특권에 의해 실행되는 것만이 다릅니다. 검색과 인스턴스 생성 방법의 상세한 것에 대하여는 getBundle를 참조하십시오.

파라미터:

baseName - 자원 번들, 완전 지정된 클래스명의 기저명

locale - 자원 번들이 필요한 로케일

반환값:

지정된 기저명과 로케일의 자원 번들

예외:

NullPointerException - baseName 또는 locale가 null인 경우

MissingResourceException - 지정된 기저명의 자원 번들이 발견되지 않는 경우

getBundle

public static ResourceBundle  getBundle(String  baseName,
                                       Locale  locale,
                                       ClassLoader  loader)

지정된 기저명, 로케일, 클래스 로더를 사용해, 자원 번들을 취득합니다.

이론적으로는 getBundle에 서는 다음의 방법을 사용해, 자원 번들의 검출 및 생성을 실시합니다.

getBundle는 기저명, 지정된 로케일 및 디폴트의 로케일 (Locale.getDefault 로부터 취득한 로케일)을 사용해, 「후보의 번들명」의 순서를 생성합니다. 지정된 로케일의 언어, 나라 및 변형이 모두 비어있는 캐릭터 라인의 경우, 기저명은 후보의 번들명에만 됩니다. 그 외의 경우에는 지정한 로케일 (language1, country1, variant1) 및 디폴트의 로케일 (language2, country2, variant2)의 속성값로부터, 다음의 순서가 생성됩니다.

• baseName + "_" + language1 + "_" + country1 + "_" + variant1
• baseName + "_" + language1 + "_" + country1
• baseName + "_" + language1
• baseName + "_" + language2 + "_" + country2 + "_" + variant2
• baseName + "_" + language2 + "_" + country2
• baseName + "_" + language2
• baseName

최종 컴퍼넌트가 비어있는 캐릭터 라인의 경우, 후보의 번들명은 생략 됩니다. 예를 들어 country1가 비어있는 캐릭터 라인의 경우, 2번째의 후보의 번들명은 생략 됩니다.

getBundle는 실제의 자원 번들을 「인스턴스화」할 수 있는 최초의 이름을 찾아내기 위해서 후보의 번들명을 반복 처리 합니다. 각 후보 번들명 마다, 자원 번들을 다음과 같이 작성하려고 합니다.

• 우선, 후보의 번들명을 사용해, 클래스를 로드하려고 합니다. 지정한 클래스 로더를 사용해, 검색해 로드한 클래스가 ResourceBundle와 호환성을 가지는 할당으로 ResourceBundle 로부터의 액세스가 가능하고, 인스턴스화할 수 있는 경우는 getBundle는 이 클래스의 새로운 인스턴스를 작성해, 「결과 자원 번들」로서 그 인스턴스를 사용합니다.
• 그 외의 경우는 getBundle는 프로퍼티 resource file를 찾아내려고 합니다. 모든 「.」문자를 「/」문자에 옮겨놓아 「. properties」캐릭터 라인을 추가해, 후보의 번들명으로부터 패스명을 생성합니다. ClassLoader.getResource를 사용해, 이 이름의 「자원」을 찾아내려고 합니다 (getResource 「자원」이란 자원 번들의 컨텐츠와는 무관계하고, 파일등의 데이터의 컨테이너에 지나지 않는다). 「자원」을 찾아냈을 경우, 자원의 컨텐츠로부터 새로운 PropertyResourceBundle 인스턴스를 작성하려고 합니다. 작성이 성공했을 경우는 이 인스턴스는 「결과 자원 번들」이 됩니다.

결과 자원 번들이 발견되지 않는 경우는 MissingResourceException가 발생 됩니다.

결과 자원 번들이 발견되었을 때는 그 친연쇄를 인스턴스화합니다. getBundle는 후보의 번들명을 반복 처리 합니다. 이 번들명은 결과 자원 번들의 번들명으로부터 변형, 나라 및 언어를 (전에 「_」에 붙은 것에 관해서 매회) 연속해 삭제하는 것에 의해 취득합니다. 전술한 것처럼, 최종 컴퍼넌트가 비어있는 캐릭터 라인인 경우, 후보의 번들명은 생략 됩니다. 각 후보의 번들명에의해 전술한 것처럼, 자원 번들을 인스턴스화하려고 합니다. 전에 인스턴스화한 자원 번들에 null 이외의 친자원 번들이 없는 한, 인스턴스에 성공했을 경우는 항상, 전에 인스턴스화한 자원 번들의 setParent 메서드를 새로운 자원 번들에 의해 호출합니다.

getBundle 구현은 인스턴스화한 자원 번들을 캐쉬해, 같은 자원 번들의 인스턴스를 여러 차례 리턴합니다. 이러한 구현에서는 결과 자원 번들 및 그 친연쇄의 선택이 전술한 것과 호환성이 있는 한, 자원 번들을 인스턴스화하는 순서를 변경하는 경우도 있습니다.

baseName인수는 완전 지정된 클래스명일 필요가 있습니다. 다만, 전버전과의 호환성에 관해서는 Sun Java 2 런타임 환경은 그것을 검증하지 않습니다. 그 때문에 완전 지정된 클래스명 ( 「.」를 사용) 대신에 패스명 ( 「/」을 사용)을 지정해, PropertyResourceBundle에 액세스 할 수 있게 됩니다.

예: 클래스와 프로퍼티 파일, MyResources.class, MyResources_fr_CH.properties, MyResources_fr_CH.class, MyResources_fr.properties, MyResources_en.properties, MyResources_es_ES.class가 제공되고 있습니다. 모든 파일의 컨텐츠가 유효합니다 (즉, 「. class」파일의 ResourceBundle 공공적이어 비추상적인 서브 클래스가 「. properties」파일의 구문을 수정한다). 디폴트의 로케일은 Locale("en", "GB") 입니다.

표시된 로케일 인수치를 가지는 getBundle 호출은 다음의 소스로부터 자원 번들을 인스턴스화합니다.

• Locale("fr", "CH"): result MyResources_fr_CH.class, parent MyResources_fr.properties, parent MyResources.class
• Locale("fr", "FR"): result MyResources_fr.properties, parent MyResources.class
• Locale("de", "DE"): result MyResources_en.properties, parent MyResources.class
• Locale("en", "US"): result MyResources_en.properties, parent MyResources.class
• Locale("es", "ES"): result MyResources_es_ES.class, parent MyResources.class

MyResources_fr_CH.properties 파일은 MyResources_fr_CH.class에 의해 숨겨지고 있으므로 사용될 것은 없습니다.

파라미터:

baseName - 자원 번들, 완전 지정된 클래스명의 기저명

locale - 자원 번들이 필요한 로케일

loader - 자원 번들의 로드원의 클래스 로더

반환값:

지정된 기저명과 로케일의 자원 번들

예외:

NullPointerException - baseName, locale 또는 loader가 null인 경우

MissingResourceException - 지정된 기저명의 자원 번들이 발견되지 않는 경우

도입된 버전 :

1.2

handleGetObject

protected abstract Object  handleGetObject(String  key)

이 자원 번들로부터 지정된 키의 객체를 취득합니다. 이 자원 번들이, 지정된 키의 객체를 포함하지 않는 경우는 null을 리턴합니다.

파라미터:

key - 바람직한 객체의 키

반환값:

지정된 키의 객체, 또는 null

예외:

NullPointerException - key가 null인 경우

getKeys

public abstract Enumeration <String > getKeys()

키의 리스트를 리턴합니다.