Modifier and Type	Class and Description
private static enum	EncodingService.SpecialEncoding Represents one of the four "special" internal encoding names: internal, external, locale, or filesystem.

Modifier and Type	Field and Description
private final CaseInsensitiveBytesHash<EncodingDB.Entry>	aliases
private final Encoding	ascii8bit
private Encoding	consoleEncoding
private static ByteList	defaultCharsetName
private Encoding	defaultExternalEncoding
private Encoding	defaultFilesystemEncoding
private Encoding	defaultInternalEncoding
private RubyEncoding[]	encodingIndex
private final IRubyObject[]	encodingList
private final CaseInsensitiveBytesHash<EncodingDB.Entry>	encodings
private static final ByteList	EXTERNAL_BL
private static final ByteList	FILESYSTEM_BL
private static final ByteList	INTERNAL_BL
private final Encoding	javaDefault
private static final ByteList	LOCALE_BL
private Encoding	localeEncoding
private static final Pattern	MS_CP_PATTERN
private final Ruby	runtime

Access	Constructor and Description
public	EncodingService(Ruby runtime)

Method Summary

Modifier and Type	Method and Description
public Charset	Returns: the charset charsetForEncoding(Encoding the encoding encoding) Get a java.nio Charset for the given encoding, or null if impossible
private void	checkAsciiEncodingName(ByteList name)
public IRubyObject	convertEncodingToRubyEncoding(Encoding defaultEncoding)
public void	defineAliases(ThreadContext context)
private void	defineEncodingConstant(ThreadContext context, RubyEncoding encoding, String constName)
public void	defineEncodings(ThreadContext context)
public EncodingDB.Entry	findAliasEntry(ByteList bytes)
public EncodingDB.Entry	findAliasEntry(byte[] bytes)
public Encoding	Returns: the Encoding object found, nil (for internal), or raises ArgumentError findEncoding(IRubyObject the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible. str) Find an encoding given a Ruby object, coercing it to a String in the process.
private Encoding	findEncodingCommon(IRubyObject str, boolean error)
private Encoding	findEncodingCommon(ByteList name, boolean error)
public EncodingDB.Entry	findEncodingEntry(ByteList bytes)
public EncodingDB.Entry	findEncodingEntry(byte[] bytes)
public Encoding	Returns: the Encoding object found, nil (for internal) findEncodingNoError(IRubyObject the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible. str) Find an encoding given a Ruby object, coercing it to a String in the process.
public Encoding	findEncodingNoError(ByteList str)
public IRubyObject	findEncodingObject(byte[] bytes)
public EncodingDB.Entry	findEncodingOrAliasEntry(ByteList bytes)
public EncodingDB.Entry	findEncodingOrAliasEntry(byte[] bytes)
public Encoding	Returns: the Encoding object found, or raises ArgumentError findEncodingWithError(ByteList the name of the encoding to look up name) Find a non-special encoding, raising argument error if it does not exist.
public EncodingDB.Entry	Returns: the Encoding object found, nil (for internal), or raises ArgumentError findEntry(IRubyObject the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible. str) Find an encoding given a Ruby object, coercing it to a String in the process.
private EncodingDB.Entry	findEntryFromEncoding(Encoding e)
private EncodingDB.Entry	Returns: the EncodingDB.Entry object found, or raises ArgumentError findEntryWithError(ByteList the name of the encoding to look up name) Find a non-special encoding Entry, raising argument error if it does not exist.
public CaseInsensitiveBytesHash<EncodingDB.Entry>	getAliases()
public Encoding	getAscii8bitEncoding()
public Encoding	Returns: console codepage getConsoleEncoding() Since Java 1.6, class `java.io.Console` is available.
public IRubyObject	getDefaultExternal()
public Encoding	getDefaultExternalEncoding()
public Encoding	getDefaultFilesystemEncoding()
public IRubyObject	getDefaultInternal()
public Encoding	getDefaultInternalEncoding()
public Encoding	getDefaultInternalEncodingOrDefault()
public RubyEncoding	getEncoding(Encoding enc)
private Encoding	getEncodingFromNKFName(final String name) Deprecated since 10.0.
public Encoding	getEncodingFromObject(IRubyObject arg)
private Encoding	getEncodingFromObjectCommon(IRubyObject arg, boolean error)
public Encoding	getEncodingFromObjectNoError(IRubyObject arg)
public Encoding	getEncodingFromString(String string)
public IRubyObject[]	getEncodingList()
public CaseInsensitiveBytesHash<EncodingDB.Entry>	getEncodings()
public Encoding	getEnvEncoding()
public Encoding	getFileSystemEncoding()
public Encoding	getFileSystemEncoding(Ruby runtime) Deprecated
public Encoding	getJavaDefault()
public Encoding	getLocaleEncoding()
public Encoding	getUSAsciiEncoding()
public Encoding	getWindowsFilesystemEncoding(Ruby runtime) Deprecated since 10.0.
public Encoding	getWindowsFilesystemEncoding(ThreadContext context)
public Encoding	loadEncoding(ByteList name)
private RubyEncoding	loadEncodingEntry(final EncodingDB.Entry entry)
public IRubyObject	rubyEncodingFromObject(IRubyObject str)
public void	setDefaultExternalEncoding(Encoding defaultExternalEncoding)
public void	setDefaultFilesystemEncoding(Encoding defaultFilesystemEncoding)
public void	setDefaultInternalEncoding(Encoding defaultInternalEncoding)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

aliases	back to summary
private final CaseInsensitiveBytesHash<EncodingDB.Entry> aliases

ascii8bit	back to summary
private final Encoding ascii8bit

consoleEncoding	back to summary
private Encoding consoleEncoding

defaultCharsetName	back to summary
private static ByteList defaultCharsetName

defaultExternalEncoding	back to summary
private Encoding defaultExternalEncoding

defaultFilesystemEncoding	back to summary
private Encoding defaultFilesystemEncoding

defaultInternalEncoding	back to summary
private Encoding defaultInternalEncoding

encodingIndex	back to summary
private RubyEncoding[] encodingIndex

encodingList	back to summary
private final IRubyObject[] encodingList

encodings	back to summary
private final CaseInsensitiveBytesHash<EncodingDB.Entry> encodings

EXTERNAL_BL	back to summary
private static final ByteList EXTERNAL_BL

FILESYSTEM_BL	back to summary
private static final ByteList FILESYSTEM_BL

INTERNAL_BL	back to summary
private static final ByteList INTERNAL_BL

javaDefault	back to summary
private final Encoding javaDefault

LOCALE_BL	back to summary
private static final ByteList LOCALE_BL

localeEncoding	back to summary
private Encoding localeEncoding

MS_CP_PATTERN	back to summary
private static final Pattern MS_CP_PATTERN

runtime	back to summary
private final Ruby runtime

Constructor Detail

EncodingService	back to summary
public EncodingService(Ruby runtime)

Method Detail

charsetForEncoding	back to summary
public Charset charsetForEncoding(Encoding encoding) Get a java.nio Charset for the given encoding, or null if impossible Parameters encoding:Encoding the encoding Returns:Charset the charset

charsetForEncoding

back to summary

public Charset charsetForEncoding(Encoding encoding)

Get a java.nio Charset for the given encoding, or null if impossible

Parameters

encoding:Encoding: the encoding

Returns:Charset

the charset

checkAsciiEncodingName	back to summary
private void checkAsciiEncodingName(ByteList name)

convertEncodingToRubyEncoding	back to summary
public IRubyObject convertEncodingToRubyEncoding(Encoding defaultEncoding)

defineAliases	back to summary
public void defineAliases(ThreadContext context)

defineEncodingConstant	back to summary
private void defineEncodingConstant(ThreadContext context, RubyEncoding encoding, String constName)

defineEncodings	back to summary
public void defineEncodings(ThreadContext context)

findAliasEntry	back to summary
public EncodingDB.Entry findAliasEntry(ByteList bytes)

findAliasEntry	back to summary
public EncodingDB.Entry findAliasEntry(byte[] bytes)

findEncoding	back to summary
public Encoding findEncoding(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process. Parameters str:IRubyObject the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible. Returns:Encoding the Encoding object found, nil (for internal), or raises ArgumentError

findEncoding

back to summary

public Encoding findEncoding(IRubyObject str)

Find an encoding given a Ruby object, coercing it to a String in the process.

Parameters

str:IRubyObject: the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible.

Returns:Encoding

the Encoding object found, nil (for internal), or raises ArgumentError

findEncodingCommon	back to summary
private Encoding findEncodingCommon(IRubyObject str, boolean error)

findEncodingCommon	back to summary
private Encoding findEncodingCommon(ByteList name, boolean error)

findEncodingEntry	back to summary
public EncodingDB.Entry findEncodingEntry(ByteList bytes)

findEncodingEntry	back to summary
public EncodingDB.Entry findEncodingEntry(byte[] bytes)

findEncodingNoError	back to summary
public Encoding findEncodingNoError(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process. This version does not raise a Ruby error if it can't find the encoding, and simply returns null. Parameters str:IRubyObject the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible. Returns:Encoding the Encoding object found, nil (for internal)

findEncodingNoError

back to summary

public Encoding findEncodingNoError(IRubyObject str)

Find an encoding given a Ruby object, coercing it to a String in the process. This version does not raise a Ruby error if it can't find the encoding, and simply returns null.

Parameters

str:IRubyObject: the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible.

Returns:Encoding

the Encoding object found, nil (for internal)

findEncodingNoError	back to summary
public Encoding findEncodingNoError(ByteList str)

findEncodingObject	back to summary
public IRubyObject findEncodingObject(byte[] bytes)

findEncodingOrAliasEntry	back to summary
public EncodingDB.Entry findEncodingOrAliasEntry(ByteList bytes)

findEncodingOrAliasEntry	back to summary
public EncodingDB.Entry findEncodingOrAliasEntry(byte[] bytes)

findEncodingWithError	back to summary
public Encoding findEncodingWithError(ByteList name) Find a non-special encoding, raising argument error if it does not exist. Parameters name:ByteList the name of the encoding to look up Returns:Encoding the Encoding object found, or raises ArgumentError

findEncodingWithError

back to summary

public Encoding findEncodingWithError(ByteList name)

Find a non-special encoding, raising argument error if it does not exist.

Parameters

name:ByteList: the name of the encoding to look up

Returns:Encoding

the Encoding object found, or raises ArgumentError

findEntry	back to summary
public EncodingDB.Entry findEntry(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process. Parameters str:IRubyObject the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible. Returns:EncodingDB.Entry the Encoding object found, nil (for internal), or raises ArgumentError

findEntry

back to summary

public EncodingDB.Entry findEntry(IRubyObject str)

Find an encoding given a Ruby object, coercing it to a String in the process.

Parameters

str:IRubyObject: the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible.

Returns:EncodingDB.Entry

the Encoding object found, nil (for internal), or raises ArgumentError

findEntryFromEncoding	back to summary
private EncodingDB.Entry findEntryFromEncoding(Encoding e)

findEntryWithError	back to summary
private EncodingDB.Entry findEntryWithError(ByteList name) Find a non-special encoding Entry, raising argument error if it does not exist. Parameters name:ByteList the name of the encoding to look up Returns:EncodingDB.Entry the EncodingDB.Entry object found, or raises ArgumentError

findEntryWithError

back to summary

private EncodingDB.Entry findEntryWithError(ByteList name)

Find a non-special encoding Entry, raising argument error if it does not exist.

Parameters

name:ByteList: the name of the encoding to look up

Returns:EncodingDB.Entry

the EncodingDB.Entry object found, or raises ArgumentError

getAliases	back to summary
public CaseInsensitiveBytesHash<EncodingDB.Entry> getAliases()

getAscii8bitEncoding	back to summary
public Encoding getAscii8bitEncoding()

getConsoleEncoding back to summary

getConsoleEncoding	back to summary
public Encoding getConsoleEncoding() Since Java 1.6, class `java.io.Console` is available. But the encoding or codepage of the underlying connected console is currently private. Had to use Reflection to get it. Returns:Encoding console codepage

public Encoding getConsoleEncoding()

Since Java 1.6, class java.io.Console is available. But the encoding or codepage of the underlying connected console is currently private. Had to use Reflection to get it.

Returns:Encoding: console codepage

getDefaultExternal	back to summary
public IRubyObject getDefaultExternal()

getDefaultExternalEncoding	back to summary
public Encoding getDefaultExternalEncoding()

getDefaultFilesystemEncoding	back to summary
public Encoding getDefaultFilesystemEncoding()

getDefaultInternal	back to summary
public IRubyObject getDefaultInternal()

getDefaultInternalEncoding	back to summary
public Encoding getDefaultInternalEncoding()

getDefaultInternalEncodingOrDefault	back to summary
public Encoding getDefaultInternalEncodingOrDefault()

getEncoding	back to summary
public RubyEncoding getEncoding(Encoding enc)

getEncodingFromNKFName	back to summary
private Encoding getEncodingFromNKFName(final String name) Deprecated since 10.0. Annotations @Deprecated since:10.0

getEncodingFromObject	back to summary
public Encoding getEncodingFromObject(IRubyObject arg)

getEncodingFromObjectCommon	back to summary
private Encoding getEncodingFromObjectCommon(IRubyObject arg, boolean error)

getEncodingFromObjectNoError	back to summary
public Encoding getEncodingFromObjectNoError(IRubyObject arg)

getEncodingFromString	back to summary
public Encoding getEncodingFromString(String string)

getEncodingList	back to summary
public IRubyObject[] getEncodingList()

getEncodings	back to summary
public CaseInsensitiveBytesHash<EncodingDB.Entry> getEncodings()

getEnvEncoding	back to summary
public Encoding getEnvEncoding()

getFileSystemEncoding	back to summary
public Encoding getFileSystemEncoding()

getFileSystemEncoding	back to summary
public Encoding getFileSystemEncoding(Ruby runtime) Deprecated Annotations @Deprecated

getJavaDefault	back to summary
public Encoding getJavaDefault()

getLocaleEncoding	back to summary
public Encoding getLocaleEncoding()

getUSAsciiEncoding	back to summary
public Encoding getUSAsciiEncoding()

getWindowsFilesystemEncoding	back to summary
public Encoding getWindowsFilesystemEncoding(Ruby runtime) Deprecated since 10.0. Annotations @Deprecated since:10.0

getWindowsFilesystemEncoding	back to summary
public Encoding getWindowsFilesystemEncoding(ThreadContext context)

loadEncoding	back to summary
public Encoding loadEncoding(ByteList name)

loadEncodingEntry	back to summary
private RubyEncoding loadEncodingEntry(final EncodingDB.Entry entry)

rubyEncodingFromObject	back to summary
public IRubyObject rubyEncodingFromObject(IRubyObject str)

setDefaultExternalEncoding	back to summary
public void setDefaultExternalEncoding(Encoding defaultExternalEncoding)

setDefaultFilesystemEncoding	back to summary
public void setDefaultFilesystemEncoding(Encoding defaultFilesystemEncoding)

setDefaultInternalEncoding	back to summary
public void setDefaultInternalEncoding(Encoding defaultInternalEncoding)

org.jruby.runtime.encoding back to summary

private final Enum EncodingService.SpecialEncoding

Class Inheritance

extends Enum<EncodingService.SpecialEncoding>

java.lang.Object
java.lang.Enum
org.jruby.runtime.encoding.EncodingService.SpecialEncoding

Represents one of the four "special" internal encoding names: internal, external, locale, or filesystem.

Field Summary

Modifier and Type	Field and Description
public static final EncodingService.SpecialEncoding	EXTERNAL
public static final EncodingService.SpecialEncoding	FILESYSTEM
public static final EncodingService.SpecialEncoding	INTERNAL
public static final EncodingService.SpecialEncoding	LOCALE

Constructor Summary

Access	Constructor and Description
private	SpecialEncoding()

Method Summary

Modifier and Type	Method and Description
public Encoding	toEncoding(Ruby runtime)
public static EncodingService.SpecialEncoding	valueOf(String name)
public static EncodingService.SpecialEncoding	valueOf(ByteList name)
public static EncodingService.SpecialEncoding[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EXTERNAL	back to summary
public static final EncodingService.SpecialEncoding EXTERNAL

FILESYSTEM	back to summary
public static final EncodingService.SpecialEncoding FILESYSTEM

INTERNAL	back to summary
public static final EncodingService.SpecialEncoding INTERNAL

LOCALE	back to summary
public static final EncodingService.SpecialEncoding LOCALE

Constructor Detail

SpecialEncoding	back to summary
private SpecialEncoding()

Method Detail

toEncoding	back to summary
public Encoding toEncoding(Ruby runtime)

valueOf	back to summary
public static EncodingService.SpecialEncoding valueOf(String name)

valueOf	back to summary
public static EncodingService.SpecialEncoding valueOf(ByteList name)

values	back to summary
public static EncodingService.SpecialEncoding[] values()

public final Class EncodingService

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum EncodingService.SpecialEncoding

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail