|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectschmitzm.lang.ResourceProvider
public class ResourceProvider
Stellt den Zugriff auf ein ResourceBundle
zur Verfuegung.
Hierbei muss der Name (Pfad) ein standard-maessig verwendeten Bundles
angebenen werden. Es besteht die Moeglichkeit, dass fehlende Ressourcen
nicht mit einer MissingResourceException
behandelt werden, sondern
mit null
, bzw. einem Alternativ-String ignoriert werden.
Zudem erlaubt es der ResourceProvider
, dass ein alternatives
Resource-Bundle spezifiziert wird (resetResourceBundle(..)
).
Ist dieses gesetzt, wird primaer darin nach einer Ressource gesucht. Nur wenn
dort die Ressource nicht gefunden wird, wird auf das Standard-Bundle
zurueckgegriffen.
Anwendungsbereich:
Diverse Standard-Libraries stellen jeweils einen eigenen ResourceProvider
zur Verfuegung, dessen Bundle im Pfad des Standard-Library hinterlegt ist (z.B.
JFreeChartUtil.RESOURCE
: Ressourcen hinterlegt in
schmitzm.jfree.ResourceBundle_XXX.properties
).
Sollen fuer eine spezielle Applikation diese Ressourcen (u.U. nur teilweise)
abgeaendert oder fuer eine neue Sprache erweitert werden, kann dies geschehen,
ohne Zugriff auf die Standard-Library zu haben. Die Applikation kann
einfach resetResourceBundle(..)
aufrufen und so den Resource-Provider anweisen, zunaechst ein applikationsspezifisches
Bundle zu verwenden (welches in einem appl.spez. Pfad hinterlegt ist).
Alle Library-internen Zugriffe werden durch den ResourceProvider
umgelenkt. Wenn das appl.spez. Bundle eine Ressource nicht zur Verfuegung stellt,
wird automatisch auf das Standard-Bundle zurueck gegriffen.
Field Summary | |
---|---|
static String |
MISSING_RESOURCE_STRING
Diese String constante wird zurückgeliefert, wenn keine Wert fuer den Schluessel gefunden wurde. |
Constructor Summary | |
---|---|
ResourceProvider(Class clazz,
Locale rootLocale)
Erzeugt neuen neuen Resource-Provider mit dem Namen "ResourceBundle". |
|
ResourceProvider(Class clazz,
Locale rootLocale,
boolean ignoreMissingResource)
Erzeugt neuen neuen Resource-Provider mit dem Namen "ResourceBundle". |
|
ResourceProvider(Class clazz,
Locale rootLocale,
boolean ignoreMissingResource,
String missingResourceString)
Erzeugt neuen neuen Resource-Provider mit dem Namen "ResourceBundle". |
|
ResourceProvider(String defaultResourceBundle,
Locale rootLocale)
Erzeugt neuen neuen Resource-Provider. |
|
ResourceProvider(String defaultResourceBundle,
Locale rootLocale,
boolean ignoreMissingResource)
Erzeugt neuen neuen Resource-Provider. |
|
ResourceProvider(String defaultResourceBundle,
Locale rootLocale,
boolean ignoreMissingResource,
String missingResourceString)
Erzeugt neuen neuen Resource-Provider. |
Method Summary | |
---|---|
static void |
createPropertyFile(ResourceProvider provider,
Locale l,
boolean append)
Erzeugt eine Property-Datei ( .properties ) fuer ein Resource Bundle. |
Set<Locale> |
getAvailableLocales(boolean inclRootLocale)
Liefert alle Sprachen, die der ResourceProvider zur Verfuegung
stellt. |
static Set<Locale> |
getAvailableLocales(ResourceProvider resourceProvider,
boolean inclRootLocale)
Liefert alle Sprachen, die ein ResourceProvider zur Verfuegung
stellt. |
String |
getBundleName()
Liefert den Namen des Resource-Bundle. |
String |
getDefaultBundleName()
Liefert den Namen des Standard-Resource-Bundle. |
String |
getKeyPrefix()
Liefert das Prefix, das im Alternativ-Bundle jedem Key vorangestellt ist. |
SortedSet<String> |
getKeys()
Liefert alle Keys unter denen eine Ressource hinterlegt ist. |
String |
getMissingResourceString()
Liefert den Alternativ-String, der beim Ignorieren fehlender Ressourcen von getString(String) zurueckgegeben wird. |
Object |
getObject(String key)
Liefert ein Objekt aus dem Resource-Bundle. |
Object |
getObject(String key,
Locale requestedLocale)
Liefert ein Objekt aus dem Resource-Bundle. |
static File |
getPropertyFile(ResourceProvider provider,
Locale l)
Liefert die Property-Datei ( .properties ) fuer ein Resource Bundle. |
Locale |
getRootLocale()
Liefert die Standard-Sprache des Resource-Bundles ("Fall-Back"). |
String |
getString(String key,
Locale requestedLocale,
Object... replParams)
Liefert einen String aus dem Resource-Bundle. |
String |
getString(String key,
Object... replParams)
Liefert einen String aus dem Resource-Bundle. |
boolean |
isMissingResourceIgnored()
Prueft, ob fehlende Ressourcen ignoriert werden (mit null oder
Alternativ-String) oder ob eine MissingResourceException
geworfen wird. |
void |
resetResourceBundle()
Entfernt das alternative Resource-Bundle, so dass im folgenden immer direkt im Standard-Bundle gesucht wird. |
void |
resetResourceBundle(String bundle)
Setzt ein alternatives Resource-Bundle, in welchem als erstes nach einer Ressource gesucht wird. |
void |
resetResourceBundle(String bundle,
String keyPrefix)
Setzt ein alternatives Resource-Bundle, in welchem als erstes nach einer Ressource gesucht wird. |
void |
setIgnoreMissingResource(boolean ignoreMissingResource)
Bestimmt, ob fehlende Ressourcen ignoriert werden (mit null oder
Alternativ-String) oder ob eine MissingResourceException
geworfen wird. |
void |
setMissingResourceString(String missingResourceString)
Setzt den Alternativ-String, der beim Ignorieren fehlender Ressourcen von getString(String) zurueckgegeben wird. |
String |
toString()
Liefert den Namen des Bundles. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String MISSING_RESOURCE_STRING
Constructor Detail |
---|
public ResourceProvider(Class clazz, Locale rootLocale)
null
oder MISSING_RESOURCE_STRING ("???")
als Alternativ-String behandelt.
defaultResourceBundle
- Name des Standard Resource-BundlerootLocale
- Sprache des Root-Bundlespublic ResourceProvider(Class clazz, Locale rootLocale, boolean ignoreMissingResource)
clazz
- Bestimmt das Package in dem das Bundle "RessourceBundle"
gesucht wirdrootLocale
- Sprache des Root-BundlesignoreMissingResource
- bestimmt, ob fehlende Ressourcen ignoriert werden
oder mit einer MissingResourceException
behandelt werdenpublic ResourceProvider(Class clazz, Locale rootLocale, boolean ignoreMissingResource, String missingResourceString)
clazz
- Bestimmt das Package in dem das Bundle "RessourceBundle"
gesucht wirdrootLocale
- Sprache des Root-BundlesignoreMissingResource
- bestimmt, ob fehlende Ressourcen ignoriert werden
oder mit einer MissingResourceException
behandelt werdenmissingResourceString
- Alternativ-String der - wenn fehlende Ressourcen
ignoriert werden - von #getString(String)
zurueckgegeben wirdpublic ResourceProvider(String defaultResourceBundle, Locale rootLocale)
null
oder MISSING_RESOURCE_STRING ("???")
als Alternativ-String behandelt.
defaultResourceBundle
- Name des Standard Resource-BundlerootLocale
- Sprache des Root-Bundlespublic ResourceProvider(String defaultResourceBundle, Locale rootLocale, boolean ignoreMissingResource)
defaultResourceBundle
- Name des Standard Resource-BundlerootLocale
- Sprache des Root-BundlesignoreMissingResource
- bestimmt, ob fehlende Ressourcen ignoriert werden
oder mit einer MissingResourceException
behandelt werdenpublic ResourceProvider(String defaultResourceBundle, Locale rootLocale, boolean ignoreMissingResource, String missingResourceString)
defaultResourceBundle
- Name des Standard Resource-BundlerootLocale
- Sprache des Root-BundlesignoreMissingResource
- bestimmt, ob fehlende Ressourcen ignoriert werden
oder mit einer MissingResourceException
behandelt werdenmissingResourceString
- Alternativ-String der - wenn fehlende Ressourcen
ignoriert werden - von #getString(String)
zurueckgegeben wirdMethod Detail |
---|
public String toString()
toString
in class Object
getBundleName()
public SortedSet<String> getKeys()
public boolean isMissingResourceIgnored()
null
oder
Alternativ-String) oder ob eine MissingResourceException
geworfen wird.
public void setIgnoreMissingResource(boolean ignoreMissingResource)
null
oder
Alternativ-String) oder ob eine MissingResourceException
geworfen wird.
public String getMissingResourceString()
getString(String)
zurueckgegeben wird.
public void setMissingResourceString(String missingResourceString)
getString(String)
zurueckgegeben wird.
public Object getObject(String key)
MissingResourceException
geworfen oder null
zurueck
gegeben.
key
- Key unter dem der String gesucht wirdpublic Object getObject(String key, Locale requestedLocale)
MissingResourceException
geworfen oder null
zurueck
gegeben.
requestedLocale
- Wenn null
, dann wird die im System verwendete
default Locale
benutzt. Sonst wir versucht der String für
diese Sprache zurückzugeben.key
- Key unter dem der String gesucht wirdpublic String getString(String key, Object... replParams)
MissingResourceException
geworfen oder der Alternativ-String
zurueck gegeben.
key
- Key unter dem der String gesucht wirdreplParams
- Strings/Zahlen, mit denen die im String enthaltenen
Wildcards ${0}
, ${1}
, ${2}
, usw.
ersetzt werden (sehr hilfreich z.B. fuer lokalisierte
Fehlermeldungen)public String getString(String key, Locale requestedLocale, Object... replParams)
MissingResourceException
geworfen oder der Alternativ-String
zurueck gegeben.
key
- Key unter dem der String gesucht wirdrequestedLocale
- Wenn null
, dann wird die im System verwendete
default Locale
benutzt. Sonst wir versucht der String für
diese Sprache zurückzugeben.replParams
- Strings/Zahlen, mit denen die im String enthaltenen
Wildcards ${0}
, ${1}
, ${2}
, usw.
ersetzt werden (sehr hilfreich z.B. fuer lokalisierte
Fehlermeldungen)public void resetResourceBundle(String bundle, String keyPrefix)
bundle
- StringkeyPrefix
- Prefix, welches bei der Suche im alternativen Bundle
automatisch jedem Key vorangestellt wirdpublic void resetResourceBundle(String bundle)
bundle
- Stringpublic void resetResourceBundle()
public String getKeyPrefix()
public String getBundleName()
public String getDefaultBundleName()
public Locale getRootLocale()
public Set<Locale> getAvailableLocales(boolean inclRootLocale)
ResourceProvider
zur Verfuegung
stellt.
inclRootLocale
- wenn false
wird die "Fall-Back"-Sprache
nicht beruecksichtigtpublic static Set<Locale> getAvailableLocales(ResourceProvider resourceProvider, boolean inclRootLocale)
ResourceProvider
zur Verfuegung
stellt.
resourceProvider
- ResourceProviderinclRootLocale
- wenn false
wird die "Fall-Back"-Sprache
nicht beruecksichtigtpublic static File getPropertyFile(ResourceProvider provider, Locale l) throws URISyntaxException
.properties
) fuer ein Resource Bundle.
provider
- Resource-Provider fuer den das neue Bundle angelegt wirdl
- Sprache des neuen Bundles
URISyntaxException
- wenn bei der Ermittlung des Datei-Pfads
ein Fehler auftrittpublic static void createPropertyFile(ResourceProvider provider, Locale l, boolean append) throws URISyntaxException, FileNotFoundException
.properties
) fuer ein Resource Bundle.
In dieser sind bereits alle Keys des Bundles enthalten und mit einem Dummy-Wert
vorbelegt.
provider
- Resource-Provider fuer den das neue Bundle angelegt wirdl
- Sprache des neuen Bundlesappend
- wenn true
, wird eine bestehende Datei erweitert,
andernfalls ueberschrieben
URISyntaxException
FileNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |