|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.4.0) E13403-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResourceBundleWrapper
Run-time and Design-time interface which abstracts the resource bundle storage.
Nested Class Summary | |
---|---|
static class |
ResourceBundleWrapper.KeyInfo
|
Method Summary | |
---|---|
java.lang.String |
addEntry(java.lang.String text,
java.util.Map<java.lang.String,java.lang.String> metadata)
Adds a new entry (value, and optional metadata) into the resource bundle and returns an automatically generated resource bundle key. |
boolean |
addEntry(java.lang.String key,
java.lang.String text,
java.util.Map<java.lang.String,java.lang.String> metadata)
Adds a new entry (key, value, and optional metadata) into the resource bundle. |
ResourceBundleOperationResult |
addEntryNoDialog(java.lang.String key,
java.lang.String text,
java.util.Map<java.lang.String,java.lang.String> metadata)
Adds a new entry (key, value, and optional metadata) into the resource bundle. |
void |
addResourceBundleListener(ResourceBundleListener listener)
Registers a listener to receive ResourceBundleEvent s
when the contents of the resource bundle change. |
boolean |
deleteEntry(java.lang.String key)
Deletes the resource bundle entry identified by key . |
java.util.Set<java.lang.String> |
findKeysByMetaData(java.util.Map<java.lang.String,java.lang.String> metadata)
Gets a Set of keys which contain the specified metadata. |
java.util.Set<java.lang.String> |
findKeysByText(java.lang.String text)
Finds the Set of keys containing an exact match for text |
java.util.Set<java.lang.String> |
findKeysLikeKey(java.lang.String key)
Finds the Set of keys identifying entries whose key
contains the substring key . |
java.util.Set<java.lang.String> |
findKeysLikeText(java.lang.String text)
Finds the Set of keys identifying entries whose translated text
contains the substring text . |
java.lang.String |
getBundleId()
Gets the bundleId associated with this instance of ResourceBundleWrapper |
ResourceBundleKeyGenerator |
getKeyGenerator()
Gets the key generator to use for making an automatic key name |
java.util.Map<java.lang.String,java.lang.String> |
getMetadata(java.lang.String key)
Gets the translated text (value) identified by key |
java.lang.String |
getString(java.lang.String key)
Gets the translated text (value) identified by key |
java.util.Set<java.lang.String> |
keySet()
Returns a set view of the keys contained in this resource bundle. |
void |
removeResourceBundleListener(ResourceBundleListener listener)
Removes a listener that received ResourceBundleEvent s. |
void |
setBundleId(java.lang.String bundleId)
Sets the bundleId associated with this instance of ResourceBundleWrapper |
void |
setKeyGenerator(ResourceBundleKeyGenerator generator)
Sets the key generator to use when using an automatic key name from addEntry(String,Map) . |
boolean |
updateEntry(java.lang.String key,
java.lang.String text,
java.util.Map<java.lang.String,java.lang.String> metadata)
Updates the specified key to have the specified text and metadata. |
ResourceBundleOperationResult |
updateEntryNoDialog(java.lang.String key,
java.lang.String text,
java.util.Map<java.lang.String,java.lang.String> metadata)
Updates the specified key to have the specified text and metadata while not showing any dialog |
Method Detail |
---|
java.lang.String getString(java.lang.String key)
key
key
- The key in the resource bundle
java.lang.NullPointerException
- if the key is null
java.util.MissingResourceException
- If the key not found in the resource
bundle.boolean addEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)
key
- The key name to use in the resource bundle.text
- The text to be translated.metadata
- Any associated metadata about the translation string
This parameter may be null
true
on success
java.lang.NullPointerException
- If key
or text
is
null
ResourceBundleOperationResult addEntryNoDialog(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)
key
- The key name to use in the resource bundle.text
- The text to be translated.metadata
- Any associated metadata about the translation string
This parameter may be null
java.lang.NullPointerException
- If key
or text
is
null
java.lang.String addEntry(java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)
text
- The text to be translated.metadata
- Any associated metadata about the translation string.
This parameter may be null
java.lang.NullPointerException
- If text
is null
boolean deleteEntry(java.lang.String key)
key
. If
key
does not exist, then a value of false
is returned.
key
- The key to delete
true
If the key is found and deleted success.
java.lang.NullPointerException
- If key
is null
.boolean updateEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)
key
- The key to updatetext
- The new text for the given keymetadata
- Any metadata to change. Existing metadata is merged with
the new metadata, unless there is a key with a null value, then the
existing metadata for that key is removed. If metadata
is
null
then the existing metadata will be unchanged.
true
on success
java.lang.NullPointerException
- If key
or text
is null
.ResourceBundleOperationResult updateEntryNoDialog(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)
key
- The key to updatetext
- The new text for the given keymetadata
- Any metadata to change. Existing metadata is merged with
the new metadata, unless there is a key with a null value, then the
existing metadata for that key is removed. If metadata
is
null
then the existing metadata will be unchanged.
java.lang.NullPointerException
java.util.Set<java.lang.String> findKeysLikeKey(java.lang.String key)
Set
of keys identifying entries whose key
contains the substring key
. No wildcards are expected or
allowed.
key
- The substring key to match
Set
of keys containing a match. If no keys match,
then an empty Set
is returned.
java.lang.NullPointerException
- If key
is null
.java.util.Set<java.lang.String> findKeysByText(java.lang.String text)
Set
of keys containing an exact match for text
text
- The exact text to match
Set
of keys containing a match. If no keys match,
then an empty Set
is returned
java.lang.NullPointerException
- If text
is null
.java.util.Set<java.lang.String> findKeysLikeText(java.lang.String text)
Set
of keys identifying entries whose translated text
contains the substring text
. No wildcards are expected or
allowed.
text
- The substring text to match
Set
of keys containing a match. If no keys match,
then an empty Set
is returned.
java.lang.NullPointerException
- If text
is null
.java.util.Set<java.lang.String> findKeysByMetaData(java.util.Map<java.lang.String,java.lang.String> metadata)
Key | Value | Result |
Key | Value | Result |
metadata
- The metadata search criteria.
Set
is returned.void addResourceBundleListener(ResourceBundleListener listener)
listener
to receive ResourceBundleEvent
s
when the contents of the resource bundle change.
listener
- the ResourceBundleListener
to register
java.lang.NullPointerException
- If listener
is null
.ResourceBundleListener
,
ResourceBundleEvent
void removeResourceBundleListener(ResourceBundleListener listener)
listener
that received ResourceBundleEvent
s.
listener
- the ResourceBundleListener
to remove
java.lang.NullPointerException
- If listener
is null
.ResourceBundleListener
,
ResourceBundleEvent
void setKeyGenerator(ResourceBundleKeyGenerator generator)
addEntry(String,Map)
.
generator
- The ResourceBundleKeyGenerator
to use.
if generator
is null
, then the default key generator
will be used.ResourceBundleKeyGenerator getKeyGenerator()
java.util.Set<java.lang.String> keySet()
Iterator
will throw an UnsupportedOperationException
.
java.util.Map<java.lang.String,java.lang.String> getMetadata(java.lang.String key)
key
key
- The key in the resource bundle
java.lang.NullPointerException
- if the key is null
java.util.MissingResourceException
- If the key not found in the resource
bundle.java.lang.String getBundleId()
void setBundleId(java.lang.String bundleId)
bundleId
- the id of the bundle
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.4.0) E13403-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |