- java.lang.Object
-
- java.nio.charset.spi.CharsetProvider
-
public abstract class CharsetProvider extends Object
Charset service-provider class.A charset provider is a concrete subclass of this class that has a zero-argument constructor and some number of associated charset implementation classes. Charset providers may be installed in an instance of the Java platform as extensions, that is, jar files placed into any of the usual extension directories. Providers may also be made available by adding them to the applet or application class path or by some other platform-specific means. Charset providers are looked up via the current thread's
context class loader
.
A charset provider identifies itself with a provider-configuration file named java.nio.charset.spi.CharsetProvider in the resource directory META-INF/services. The file should contain a list of fully-qualified concrete charset-provider class names, one per line. A line is terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a line feed. Space and tab characters surrounding each name, as well as blank lines, are ignored. The comment character is '#' ('\u0023'); on each line all characters following the first comment character are ignored. The file must be encoded in UTF-8.
If a particular concrete charset provider class is named in more than one configuration file, or is named in the same configuration file more than once, then the duplicates will be ignored. The configuration file naming a particular provider need not be in the same jar file or other distribution unit as the provider itself. The provider must be accessible from the same class loader that was initially queried to locate the configuration file; this is not necessarily the class loader that loaded the file.
- Since:
- 1.4
- See Also:
Charset
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
CharsetProvider()
Initializes a new charset provider.
-
-
-
Constructor Detail
-
CharsetProvider
protected CharsetProvider()
Initializes a new charset provider.- Throws:
SecurityException
- If a security manager has been installed and it deniesRuntimePermission
("charsetProvider")
-
-
Method Detail
-
charsets
public abstract Iterator<Charset> charsets()
Creates an iterator that iterates over the charsets supported by this provider. This method is used in the implementation of theCharset.availableCharsets
method.- Returns:
- The new iterator
-
charsetForName
public abstract Charset charsetForName(String charsetName)
Retrieves a charset for the given charset name.- Parameters:
charsetName
- The name of the requested charset; may be either a canonical name or an alias- Returns:
- A charset object for the named charset, or null if the named charset is not supported by this provider
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/nio/charset/spi/charsetprovider.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.