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 를 슬로우 합니다.

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 ()
유일한 constructor 입니다.

메소드의 개요

static ResourceBundle	getBundle (String baseName) 지정된 기저명, 디폴트의 로케일, 및 호출측의 클래스 로더를 사용해, 리소스 번들을 취득합니다.
static ResourceBundle	getBundle (String baseName, Locale locale) 지정된 기저명, 로케일, 및 호출측의 클래스 로더를 사용해, 리소스 번들을 취득합니다.
static ResourceBundle	getBundle (String baseName, Locale locale, ClassLoader loader) 지정된 기저명, 로케일, 클래스 로더를 사용해, 리소스 번들을 취득합니다.
abstract Enumeration	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()

유일한 constructor 입니다. 서브 클래스의 constructor 에 의한 호출은 통상은 암묵적인 호출입니다.

메소드의 상세

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 를 슬로우 합니다.

파라미터:

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", "UK") 입니다.

표시된 로케일 인수치를 가지는 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  getKeys()

키의 리스트를 돌려줍니다.