org.jruby.runtime.encoding

Class EncodingService

java.lang.Object

org.jruby.runtime.encoding.EncodingService

public final class EncodingService
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EncodingService.EncodingAliasVisitor
static interface	EncodingService.EncodingDefinitionVisitor

Field Summary

Fields

Modifier and Type	Field and Description
IRubyObject[]	encodingList

Constructor Summary

Constructors

Constructor and Description
EncodingService(Ruby runtime)

Method Summary

Methods

Modifier and Type	Method and Description
Charset	charsetForEncoding(org.jcodings.Encoding encoding) Get a java.nio Charset for the given encoding, or null if impossible
IRubyObject	convertEncodingToRubyEncoding(org.jcodings.Encoding defaultEncoding)
void	defineAliases()
void	defineAliases(EncodingService.EncodingAliasVisitor visitor)
void	defineEncodings()
void	defineEncodings(EncodingService.EncodingDefinitionVisitor visitor)
org.jcodings.EncodingDB.Entry	findAliasEntry(byte[] bytes)
org.jcodings.EncodingDB.Entry	findAliasEntry(org.jruby.util.ByteList bytes)
org.jcodings.Encoding	findEncoding(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process.
org.jcodings.EncodingDB.Entry	findEncodingEntry(byte[] bytes)
org.jcodings.EncodingDB.Entry	findEncodingEntry(org.jruby.util.ByteList bytes)
org.jcodings.Encoding	findEncodingNoError(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process.
IRubyObject	findEncodingObject(byte[] bytes)
org.jcodings.EncodingDB.Entry	findEncodingOrAliasEntry(byte[] bytes)
org.jcodings.EncodingDB.Entry	findEncodingOrAliasEntry(org.jruby.util.ByteList bytes)
org.jcodings.Encoding	findEncodingWithError(org.jruby.util.ByteList name) Find a non-special encoding, raising argument error if it does not exist.
org.jcodings.EncodingDB.Entry	findEntry(IRubyObject str) Find an encoding given a Ruby object, coercing it to a String in the process.
org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry>	getAliases()
org.jcodings.Encoding	getAscii8bitEncoding()
org.jcodings.Encoding	getConsoleEncoding() Since Java 1.6, class Console is available.
IRubyObject	getDefaultExternal()
IRubyObject	getDefaultInternal()
RubyEncoding	getEncoding(org.jcodings.Encoding enc)
org.jcodings.Encoding	getEncodingFromObject(IRubyObject arg)
org.jcodings.Encoding	getEncodingFromObjectNoError(IRubyObject arg)
org.jcodings.Encoding	getEncodingFromString(String string)
IRubyObject[]	getEncodingList()
org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry>	getEncodings()
org.jcodings.Encoding	getFileSystemEncoding(Ruby runtime)
org.jcodings.Encoding	getJavaDefault()
org.jcodings.Encoding	getLocaleEncoding()
org.jcodings.Encoding	getUSAsciiEncoding()
org.jcodings.Encoding	loadEncoding(org.jruby.util.ByteList name)
IRubyObject	rubyEncodingFromObject(IRubyObject str)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

encodingList

public final IRubyObject[] encodingList

Constructor Detail

EncodingService

public EncodingService(Ruby runtime)

Method Detail

getConsoleEncoding

public org.jcodings.Encoding getConsoleEncoding()

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

Returns:

console codepage

getUSAsciiEncoding

public org.jcodings.Encoding getUSAsciiEncoding()

getAscii8bitEncoding

public org.jcodings.Encoding getAscii8bitEncoding()

getFileSystemEncoding

public org.jcodings.Encoding getFileSystemEncoding(Ruby runtime)

getEncodings

public org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry> getEncodings()

getAliases

public org.jcodings.util.CaseInsensitiveBytesHash<org.jcodings.EncodingDB.Entry> getAliases()

findEncodingEntry

public org.jcodings.EncodingDB.Entry findEncodingEntry(org.jruby.util.ByteList bytes)

findEncodingEntry

public org.jcodings.EncodingDB.Entry findEncodingEntry(byte[] bytes)

findAliasEntry

public org.jcodings.EncodingDB.Entry findAliasEntry(org.jruby.util.ByteList bytes)

findAliasEntry

public org.jcodings.EncodingDB.Entry findAliasEntry(byte[] bytes)

findEncodingOrAliasEntry

public org.jcodings.EncodingDB.Entry findEncodingOrAliasEntry(org.jruby.util.ByteList bytes)

findEncodingOrAliasEntry

public org.jcodings.EncodingDB.Entry findEncodingOrAliasEntry(byte[] bytes)

getLocaleEncoding

public org.jcodings.Encoding getLocaleEncoding()

getEncodingList

public IRubyObject[] getEncodingList()

loadEncoding

public org.jcodings.Encoding loadEncoding(org.jruby.util.ByteList name)

getEncoding

public RubyEncoding getEncoding(org.jcodings.Encoding enc)

defineEncodings

public void defineEncodings()

defineEncodings

public void defineEncodings(EncodingService.EncodingDefinitionVisitor visitor)

defineAliases

public void defineAliases()

defineAliases

public void defineAliases(EncodingService.EncodingAliasVisitor visitor)

getDefaultExternal

public IRubyObject getDefaultExternal()

getDefaultInternal

public IRubyObject getDefaultInternal()

convertEncodingToRubyEncoding

public IRubyObject convertEncodingToRubyEncoding(org.jcodings.Encoding defaultEncoding)

findEncodingObject

public IRubyObject findEncodingObject(byte[] bytes)

getJavaDefault

public org.jcodings.Encoding getJavaDefault()

getEncodingFromObject

public org.jcodings.Encoding getEncodingFromObject(IRubyObject arg)

getEncodingFromObjectNoError

public org.jcodings.Encoding getEncodingFromObjectNoError(IRubyObject arg)

getEncodingFromString

public org.jcodings.Encoding getEncodingFromString(String string)

findEncoding

public org.jcodings.Encoding findEncoding(IRubyObject str)

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

Parameters:

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

Returns:

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

findEncodingNoError

public org.jcodings.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 - the object to coerce and use to look up encoding. The coerced String must be ASCII-compatible.

Returns:

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

findEntry

public org.jcodings.EncodingDB.Entry findEntry(IRubyObject str)

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

Parameters:

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

Returns:

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

rubyEncodingFromObject

public IRubyObject rubyEncodingFromObject(IRubyObject str)

charsetForEncoding

public Charset charsetForEncoding(org.jcodings.Encoding encoding)

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

Parameters:

encoding - the encoding

Returns:

the charset

findEncodingWithError

public org.jcodings.Encoding findEncodingWithError(org.jruby.util.ByteList name)

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

Parameters:

name - the name of the encoding to look up

Returns:

the Encoding object found, or raises ArgumentError