This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
java.util
class ListResourceBundle
- Direct Known Subclasses:
- AccessibleResourceBundle
public abstract class ListResourceBundle
extends ResourceBundle
ListResourceBundle
is an abstract subclass of
ResourceBundle
that manages resources for a locale
in a convenient and easy to use list. See ResourceBundle
for
more information about resource bundles in general.
Subclasses must override getContents
and provide an array,
where each item in the array is a pair of objects.
The first element of each pair is the key, which must be a
String
, and the second element is the value associated with
that key.
The following example shows two members of a resource
bundle family with the base name "MyResources".
"MyResources" is the default member of the bundle family, and
"MyResources_fr" is the French member.
These members are based on ListResourceBundle
(a related example shows
how you can add a bundle to this family that's based on a properties file).
The keys in this example are of the form "s1" etc. The actual
keys are entirely up to your choice, so long as they are the same as
the keys you use in your program to retrieve the objects from the bundle.
Keys are case-sensitive.
public class MyResources extends ListResourceBundle {
protected Object[][] getContents() {
return new Object[][] = {
// LOCALIZE THIS
{"s1", "The disk \"{1}\" contains {0}."}, // MessageFormat pattern
{"s2", "1"}, // location of {0} in pattern
{"s3", "My Disk"}, // sample disk name
{"s4", "no files"}, // first ChoiceFormat choice
{"s5", "one file"}, // second ChoiceFormat choice
{"s6", "{0,number} files"}, // third ChoiceFormat choice
{"s7", "3 Mar 96"}, // sample date
{"s8", new Dimension(1,5)} // real object, not just string
// END OF MATERIAL TO LOCALIZE
};
}
}
public class MyResources_fr extends ListResourceBundle {
protected Object[][] getContents() {
return new Object[][] = {
// LOCALIZE THIS
{"s1", "Le disque \"{1}\" {0}."}, // MessageFormat pattern
{"s2", "1"}, // location of {0} in pattern
{"s3", "Mon disque"}, // sample disk name
{"s4", "ne contient pas de fichiers"}, // first ChoiceFormat choice
{"s5", "contient un fichier"}, // second ChoiceFormat choice
{"s6", "contient {0,number} fichiers"}, // third ChoiceFormat choice
{"s7", "3 mars 1996"}, // sample date
{"s8", new Dimension(1,3)} // real object, not just string
// END OF MATERIAL TO LOCALIZE
};
}
}
Constructor Summary |
Sole constructor.
|
Method Summary |
protected abstract Object[][] |
Returns an array in which each item is a pair of objects in an
Object array.
|
Enumeration |
Returns an Enumeration of the keys contained in
this ResourceBundle and its parent bundles.
|
Object |
Gets an object for the given key from this resource bundle.
|
protected Set |
Returns a Set of the keys contained
only in this ResourceBundle .
|
Methods inherited from class java.util.ResourceBundle |
clearCache, clearCache, containsKey, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getKeys, getLocale, getObject, getString, getStringArray, handleGetObject, handleKeySet, keySet, setParent |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ListResourceBundle
public ListResourceBundle()
-
Sole constructor. (For invocation by subclass constructors, typically
implicit.)
getContents
protected abstract Object[][] getContents()
-
Returns an array in which each item is a pair of objects in an
Object
array. The first element of each pair is
the key, which must be a String
, and the second
element is the value associated with that key. See the class
description for details.
- Returns:
- an array of an
Object
array representing a
key-value pair.
getKeys
public Enumeration getKeys()
-
Returns an
Enumeration
of the keys contained in
this ResourceBundle
and its parent bundles.
- Overrides:
getKeys
in class ResourceBundle
- Returns:
- an
Enumeration
of the keys contained in
this ResourceBundle
and its parent bundles.
handleGetObject
public final Object handleGetObject(String key)
-
- Overrides:
handleGetObject
in class ResourceBundle
- Parameters:
key
handleKeySet
protected Set handleKeySet()
-
Returns a
Set
of the keys contained
only in this ResourceBundle
.
- Overrides:
handleKeySet
in class ResourceBundle
- Returns:
- a
Set
of the keys contained only in this
ResourceBundle
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.