Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	RubyEncoding.RawCoder A cached decoder object to decode bytes as raw binary (ISO-8859-1 or ASCII-8BIT) content.
private static class	RubyEncoding.UTF8Coder A cached decoder for UTF-8 bytes.

Field Summary

Modifier and Type	Field and Description
public static final ByteList	BINARY_ASCII_NAME
private static final int	CHAR_THRESHOLD The maximum number of characters we can encode/decode in our cached buffers
private final transient Object	constant
private Encoding	encoding
public static final ByteList	EXTERNAL
public static final ByteList	FILESYSTEM
public static final ByteList	INTERNAL
private final boolean	isDummy
public static final Charset	ISO
public static final ByteList	LOCALE
private final ByteList	name
private static final ThreadLocal<SoftReference<RubyEncoding.RawCoder>>	RAW_CODER Thread-local RawCoder wrapped in a SoftReference to avoid possible ClassLoader leak.
public static final Charset	UTF16
public static final Charset	UTF8
private static final ThreadLocal<SoftReference<RubyEncoding.UTF8Coder>>	UTF8_CODER Thread-local UTF8Coder wrapped in a SoftReference to avoid possible ClassLoader leak.

Inherited from org.jruby.RubyObject:: IVAR_INSPECTING_OBJECT_ALLOCATOR OBJECT_ALLOCATOR REIFYING_OBJECT_ALLOCATOR

Constructor Summary

Access	Constructor and Description
private	RubyEncoding(Ruby runtime, byte[] name, int p, int end, boolean isDummy)
private	RubyEncoding(Ruby runtime, byte[] name, Encoding encoding, boolean isDummy)
private	RubyEncoding(Ruby runtime, ByteList name, Encoding encoding, boolean isDummy)

Method Summary

Modifier and Type	Method and Description
public IRubyObject	_dump(ThreadContext context, IRubyObject arg)
public static IRubyObject	_load(ThreadContext context, IRubyObject recv, IRubyObject str)
private static void	addSpecialAlias(ThreadContext context, RubyHash result, ByteList alias, Encoding encoding)
public static IRubyObject	aliases(ThreadContext context, IRubyObject recv)
public static Encoding	areCompatible(IRubyObject obj1, IRubyObject obj2)
public static Encoding	areCompatible(Encoding enc1, int cr1, Encoding enc2, int cr2)
public IRubyObject	asciiCompatible_p(ThreadContext context)
public static Encoding	Returns: a negotiated encoding, if compatible; null otherwise checkEncoding(ThreadContext the current thread context context, Encoding the first encoding encoding, CodeRangeable the `CodeRangeable` from which to get bytes and the second encoding other) Check whether the given encoding and the encoding from the given `CodeRangeable` are compatible.
public static IRubyObject	compatible_p(ThreadContext context, IRubyObject self, IRubyObject first, IRubyObject second)
public Object	constant() Implements org.jruby.compiler.Constantizable.constant.
public static RubyClass	createEncodingClass(ThreadContext context, RubyClass Object)
public static String	decode(byte[] bytes, int start, int length, Charset charset)
public static String	decode(byte[] bytes, Charset charset)
public static String	decodeISO(byte[] bytes, int start, int length) Deprecated use `decodeRaw(byte[], int, int)`
public static String	decodeISO(ByteList byteList) Deprecated use `decodeRaw(ByteList)`
public static String	Returns: a decoded String based on raw bytes decodeRaw(byte[] the byte array bytes, int start of content start, int length of content length) Decode the range of bytes specified as "raw" binary content, as in ISO-8859-1 or ASCII-8BIT encodings.
public static String	Returns: a decoded string based on raw bytes decodeRaw(ByteList byteList) Decode the specified bytelist as "raw" binary content.
private static char[]	decodeRawLoop(byte[] s, int start, int length)
public static String	Returns: a decoded String based on UTF-8 bytes decodeUTF8(byte[] the byte array bytes, int start of content start, int length of content length) Decode the range of bytes specified as UTF-8 content.
public static String	decodeUTF8(byte[] bytes)
pack-priv static ByteList	doEncode(String cs, Charset charset, Encoding enc)
pack-priv static ByteList	doEncode(CharSequence cs, Charset charset, Encoding enc)
pack-priv static ByteList	doEncodeUTF16(String str)
pack-priv static ByteList	doEncodeUTF16(CharSequence str)
pack-priv static ByteList	doEncodeUTF8(String str)
pack-priv static ByteList	doEncodeUTF8(CharSequence str)
public IRubyObject	dummy_p(ThreadContext context)
public static byte[]	encode(CharSequence cs, Charset charset)
public static byte[]	encode(String str, Charset charset)
public static byte[]	encodeISO(CharSequence str)
public static byte[]	encodeISO(char[] str)
private static byte[]	encodeISOLoop(char[] s)
private static byte[]	encodeISOLoop(CharSequence s)
public static byte[]	encodeUTF16(String str)
public static byte[]	encodeUTF16(CharSequence str)
public static byte[]	encodeUTF8(String str)
public static byte[]	encodeUTF8(CharSequence str)
private static Encoding	extractEncodingFromObject(IRubyObject obj)
public static IRubyObject	find(ThreadContext context, IRubyObject recv, IRubyObject str)
private static ByteList	getByteList(final ByteBuffer buffer, final Encoding enc, final boolean shared)
private static byte[]	getBytes(final ByteBuffer buffer)
public static IRubyObject	getDefaultExternal(ThreadContext context, IRubyObject recv)
public static IRubyObject	getDefaultInternal(ThreadContext context, IRubyObject recv)
public static IRubyObject	getDefaultInternal(IRubyObject recv) Deprecated
public final Encoding	getEncoding()
private static RubyEncoding.RawCoder	getRawCoder()
private static RubyEncoding.UTF8Coder	getUTF8Coder()
public IRubyObject	inspect(ThreadContext context) Overrides org.jruby.RubyBasicObject.inspect. Overrides default org.jruby.runtime.builtin.IRubyObject.inspect. Returns a string containing a human-readable representation of obj.
private ByteList	inspectName()
public static IRubyObject	list(ThreadContext context, IRubyObject recv)
public static IRubyObject	locale_charmap(ThreadContext context, IRubyObject recv)
public static IRubyObject	name_list(ThreadContext context, IRubyObject recv)
public IRubyObject	names(ThreadContext context)
public static RubyEncoding	newEncoding(Ruby runtime, byte[] name, int p, int end, boolean isDummy)
public IRubyObject	replicate(ThreadContext context, IRubyObject arg) Deprecated since 10.0.
public static IRubyObject	setDefaultExternal(ThreadContext context, IRubyObject recv, IRubyObject encoding)
public static IRubyObject	setDefaultInternal(ThreadContext context, IRubyObject recv, IRubyObject encoding)
public IRubyObject	to_s(ThreadContext context) Overrides org.jruby.RubyBasicObject.to_s.
private static CharBuffer	toCharBuffer(CharSequence str)

Field Detail

BINARY_ASCII_NAME	back to summary
public static final ByteList BINARY_ASCII_NAME

CHAR_THRESHOLD	back to summary
private static final int CHAR_THRESHOLD The maximum number of characters we can encode/decode in our cached buffers

constant	back to summary
private final transient Object constant

encoding	back to summary
private Encoding encoding

EXTERNAL	back to summary
public static final ByteList EXTERNAL

FILESYSTEM	back to summary
public static final ByteList FILESYSTEM

INTERNAL	back to summary
public static final ByteList INTERNAL

isDummy	back to summary
private final boolean isDummy

ISO	back to summary
public static final Charset ISO

LOCALE	back to summary
public static final ByteList LOCALE

name	back to summary
private final ByteList name

RAW_CODER	back to summary
private static final ThreadLocal<SoftReference<RubyEncoding.RawCoder>> RAW_CODER Thread-local RawCoder wrapped in a SoftReference to avoid possible ClassLoader leak. See JRUBY-6522

UTF16	back to summary
public static final Charset UTF16

UTF8	back to summary
public static final Charset UTF8

UTF8_CODER	back to summary
private static final ThreadLocal<SoftReference<RubyEncoding.UTF8Coder>> UTF8_CODER Thread-local UTF8Coder wrapped in a SoftReference to avoid possible ClassLoader leak. See JRUBY-6522

Constructor Detail

RubyEncoding	back to summary
private RubyEncoding(Ruby runtime, byte[] name, int p, int end, boolean isDummy)

RubyEncoding	back to summary
private RubyEncoding(Ruby runtime, byte[] name, Encoding encoding, boolean isDummy)

RubyEncoding	back to summary
private RubyEncoding(Ruby runtime, ByteList name, Encoding encoding, boolean isDummy)

Method Detail

_dump	back to summary
public IRubyObject _dump(ThreadContext context, IRubyObject arg) Annotations @JRubyMethod name:_dump

_load	back to summary
public static IRubyObject _load(ThreadContext context, IRubyObject recv, IRubyObject str) Annotations @JRubyMethod name:_load meta:true

addSpecialAlias	back to summary
private static void addSpecialAlias(ThreadContext context, RubyHash result, ByteList alias, Encoding encoding)

aliases	back to summary
public static IRubyObject aliases(ThreadContext context, IRubyObject recv) Annotations @SuppressWarnings:unchecked @JRubyMethod name:aliases meta:true

areCompatible	back to summary
public static Encoding areCompatible(IRubyObject obj1, IRubyObject obj2)

areCompatible	back to summary
public static Encoding areCompatible(Encoding enc1, int cr1, Encoding enc2, int cr2)

asciiCompatible_p	back to summary
public IRubyObject asciiCompatible_p(ThreadContext context) Annotations @JRubyMethod name:ascii_compatible?

checkEncoding back to summary

checkEncoding	back to summary
public static Encoding checkEncoding(ThreadContext context, Encoding encoding, CodeRangeable other) Check whether the given encoding and the encoding from the given `CodeRangeable` are compatible. This version differs from `RubyString#checkEncoding(CodeRangeable)` in that the contents of the first encoding's string are not taken into consideration (e.g. blank first string does not skip compatibility check with second string's encoding). See rb_enc_check in CRuby and use from stringio that passes encoding instead of string for the first argument. See https://github.com/ruby/stringio/pull/116 for some discussion MRI: rb_enc_check with encoding for first parameter Parameters context:ThreadContext the current thread context encoding:Encoding the first encoding other:CodeRangeable the `CodeRangeable` from which to get bytes and the second encoding Returns:Encoding a negotiated encoding, if compatible; null otherwise

public static Encoding checkEncoding(ThreadContext context, Encoding encoding, CodeRangeable other)

Check whether the given encoding and the encoding from the given CodeRangeable are compatible. This version differs from RubyString#checkEncoding(CodeRangeable) in that the contents of the first encoding's string are not taken into consideration (e.g. blank first string does not skip compatibility check with second string's encoding). See rb_enc_check in CRuby and use from stringio that passes encoding instead of string for the first argument. See https://github.com/ruby/stringio/pull/116 for some discussion MRI: rb_enc_check with encoding for first parameter

Parameters

context:ThreadContext: the current thread context
encoding:Encoding: the first encoding
other:CodeRangeable: the CodeRangeable from which to get bytes and the second encoding

Returns:Encoding

a negotiated encoding, if compatible; null otherwise

compatible_p	back to summary
public static IRubyObject compatible_p(ThreadContext context, IRubyObject self, IRubyObject first, IRubyObject second) Annotations @JRubyMethod name:compatible? meta:true

constant back to summary

constant	back to summary
public Object constant() Implements org.jruby.compiler.Constantizable.constant. Annotations @Override See Also `org.jruby.compiler.Constantizable`

public Object constant()

Implements org.jruby.compiler.Constantizable.constant.

Annotations

@Override

See Also

org.jruby.compiler.Constantizable

createEncodingClass	back to summary
public static RubyClass createEncodingClass(ThreadContext context, RubyClass Object)

decode	back to summary
public static String decode(byte[] bytes, int start, int length, Charset charset)

decode	back to summary
public static String decode(byte[] bytes, Charset charset)

decodeISO	back to summary
public static String decodeISO(byte[] bytes, int start, int length) Deprecated use `decodeRaw(byte[], int, int)` Annotations @Deprecated

decodeISO	back to summary
public static String decodeISO(ByteList byteList) Deprecated use `decodeRaw(ByteList)` Annotations @Deprecated

decodeRaw back to summary

decodeRaw	back to summary
public static String decodeRaw(byte[] bytes, int start, int length) Decode the range of bytes specified as "raw" binary content, as in ISO-8859-1 or ASCII-8BIT encodings. This will attempt to use a zero-allocation decoder if the content length is shorter than `CHAR_THRESHOLD` bytes, and otherwise will used cached decoders to avoid reallocating Charset-related objects. Parameters bytes:byte[] the byte array start:int start of content length:int length of content Returns:String a decoded String based on raw bytes

public static String decodeRaw(byte[] bytes, int start, int length)

Decode the range of bytes specified as "raw" binary content, as in ISO-8859-1 or ASCII-8BIT encodings. This will attempt to use a zero-allocation decoder if the content length is shorter than CHAR_THRESHOLD bytes, and otherwise will used cached decoders to avoid reallocating Charset-related objects.

Parameters

bytes:byte[]: the byte array
start:int: start of content
length:int: length of content

Returns:String

a decoded String based on raw bytes

decodeRaw back to summary

decodeRaw	back to summary
public static String decodeRaw(ByteList byteList) Decode the specified bytelist as "raw" binary content. This is the same as calling `decodeRaw(byte[], int, int)` with the contents of byteList. Returns:String a decoded string based on raw bytes

public static String decodeRaw(ByteList byteList)

Decode the specified bytelist as "raw" binary content. This is the same as calling decodeRaw(byte[], int, int) with the contents of byteList.

Returns:String: a decoded string based on raw bytes

decodeRawLoop	back to summary
private static char[] decodeRawLoop(byte[] s, int start, int length)

decodeUTF8 back to summary

decodeUTF8	back to summary
public static String decodeUTF8(byte[] bytes, int start, int length) Decode the range of bytes specified as UTF-8 content. This will attempt to use a zero-allocation decoder if the content length is shorter than `CHAR_THRESHOLD` bytes, and otherwise will used cached decoders to avoid reallocating Charset-related objects. Parameters bytes:byte[] the byte array start:int start of content length:int length of content Returns:String a decoded String based on UTF-8 bytes

public static String decodeUTF8(byte[] bytes, int start, int length)

Decode the range of bytes specified as UTF-8 content. This will attempt to use a zero-allocation decoder if the content length is shorter than CHAR_THRESHOLD bytes, and otherwise will used cached decoders to avoid reallocating Charset-related objects.

Parameters

bytes:byte[]: the byte array
start:int: start of content
length:int: length of content

Returns:String

a decoded String based on UTF-8 bytes

decodeUTF8	back to summary
public static String decodeUTF8(byte[] bytes)

doEncode	back to summary
pack-priv static ByteList doEncode(String cs, Charset charset, Encoding enc)

doEncode	back to summary
pack-priv static ByteList doEncode(CharSequence cs, Charset charset, Encoding enc)

doEncodeUTF16	back to summary
pack-priv static ByteList doEncodeUTF16(String str)

doEncodeUTF16	back to summary
pack-priv static ByteList doEncodeUTF16(CharSequence str)

doEncodeUTF8	back to summary
pack-priv static ByteList doEncodeUTF8(String str)

doEncodeUTF8	back to summary
pack-priv static ByteList doEncodeUTF8(CharSequence str)

dummy_p	back to summary
public IRubyObject dummy_p(ThreadContext context) Annotations @JRubyMethod name:dummy?

encode	back to summary
public static byte[] encode(CharSequence cs, Charset charset)

encode	back to summary
public static byte[] encode(String str, Charset charset)

encodeISO	back to summary
public static byte[] encodeISO(CharSequence str)

encodeISO	back to summary
public static byte[] encodeISO(char[] str)

encodeISOLoop	back to summary
private static byte[] encodeISOLoop(char[] s)

encodeISOLoop	back to summary
private static byte[] encodeISOLoop(CharSequence s)

encodeUTF16	back to summary
public static byte[] encodeUTF16(String str)

encodeUTF16	back to summary
public static byte[] encodeUTF16(CharSequence str)

encodeUTF8	back to summary
public static byte[] encodeUTF8(String str)

encodeUTF8	back to summary
public static byte[] encodeUTF8(CharSequence str)

extractEncodingFromObject	back to summary
private static Encoding extractEncodingFromObject(IRubyObject obj)

find	back to summary
public static IRubyObject find(ThreadContext context, IRubyObject recv, IRubyObject str) Annotations @JRubyMethod name:find meta:true

getByteList	back to summary
private static ByteList getByteList(final ByteBuffer buffer, final Encoding enc, final boolean shared)

getBytes	back to summary
private static byte[] getBytes(final ByteBuffer buffer)

getDefaultExternal	back to summary
public static IRubyObject getDefaultExternal(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:default_external meta:true

getDefaultInternal	back to summary
public static IRubyObject getDefaultInternal(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:default_internal meta:true

getDefaultInternal	back to summary
public static IRubyObject getDefaultInternal(IRubyObject recv) Deprecated Annotations @Deprecated

getEncoding	back to summary
public final Encoding getEncoding()

getRawCoder	back to summary
private static RubyEncoding.RawCoder getRawCoder()

getUTF8Coder	back to summary
private static RubyEncoding.UTF8Coder getUTF8Coder()

inspect back to summary

public IRubyObject inspect(ThreadContext context)

Overrides org.jruby.RubyBasicObject.inspect.

Overrides default org.jruby.runtime.builtin.IRubyObject.inspect.

Doc from org.jruby.RubyBasicObject.inspect.

Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Annotations

@JRubyMethod
name:inspect

inspectName	back to summary
private ByteList inspectName()

list	back to summary
public static IRubyObject list(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:list meta:true

locale_charmap	back to summary
public static IRubyObject locale_charmap(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:locale_charmap meta:true

name_list	back to summary
public static IRubyObject name_list(ThreadContext context, IRubyObject recv) Annotations @SuppressWarnings:unchecked @JRubyMethod name:name_list meta:true

names	back to summary
public IRubyObject names(ThreadContext context) Annotations @SuppressWarnings:unchecked @JRubyMethod name:names

newEncoding	back to summary
public static RubyEncoding newEncoding(Ruby runtime, byte[] name, int p, int end, boolean isDummy)

replicate	back to summary
public IRubyObject replicate(ThreadContext context, IRubyObject arg) Deprecated since 10.0. Annotations @Deprecated since:10.0

setDefaultExternal	back to summary
public static IRubyObject setDefaultExternal(ThreadContext context, IRubyObject recv, IRubyObject encoding) Annotations @JRubyMethod name:default_external= meta:true

setDefaultInternal	back to summary
public static IRubyObject setDefaultInternal(ThreadContext context, IRubyObject recv, IRubyObject encoding) Annotations @JRubyMethod name:default_internal= meta:true

to_s

back to summary

public IRubyObject to_s(ThreadContext context)

Overrides org.jruby.RubyBasicObject.to_s.

Annotations

@JRubyMethod
name:to_s, name

toCharBuffer	back to summary
private static CharBuffer toCharBuffer(CharSequence str)

org.jruby back to summary

private Class RubyEncoding.RawCoder

Class Inheritance

extends Object

java.lang.Object
org.jruby.RubyEncoding.RawCoder

A cached decoder object to decode bytes as raw binary (ISO-8859-1 or ASCII-8BIT) content.

Field Summary

Modifier and Type	Field and Description
private final char[]	charBuffer

Constructor Summary

Access	Constructor and Description
private	RawCoder()

Method Summary

Modifier and Type	Method and Description
public final String	decode(byte[] bytes, int start, int length)

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

Field Detail

charBuffer	back to summary
private final char[] charBuffer

Constructor Detail

RawCoder	back to summary
private RawCoder()

Method Detail

decode	back to summary
public final String decode(byte[] bytes, int start, int length)

org.jruby back to summary

private Class RubyEncoding.UTF8Coder

Class Inheritance

extends Object

java.lang.Object
org.jruby.RubyEncoding.UTF8Coder

A cached decoder for UTF-8 bytes.

Field Summary

Modifier and Type	Field and Description
private static final int	BUF_SIZE The resulting encode/decode buffer sized by the max number of characters (using 4 bytes per char possible for utf-8)
private final ByteBuffer	byteBuffer
private final CharBuffer	charBuffer
private final CharsetDecoder	decoder
private final CharsetEncoder	encoder

Constructor Summary

Access	Constructor and Description
pack-priv	UTF8Coder()

Method Summary

Modifier and Type	Method and Description
public final CharBuffer	decode(byte[] bytes, int start, int length)
public final ByteBuffer	encode(String str)
public final ByteBuffer	encode(CharSequence str)

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

Field Detail

BUF_SIZE	back to summary
private static final int BUF_SIZE The resulting encode/decode buffer sized by the max number of characters (using 4 bytes per char possible for utf-8)

byteBuffer	back to summary
private final ByteBuffer byteBuffer

charBuffer	back to summary
private final CharBuffer charBuffer

decoder	back to summary
private final CharsetDecoder decoder

encoder	back to summary
private final CharsetEncoder encoder

Constructor Detail

UTF8Coder	back to summary
pack-priv UTF8Coder()

Method Detail

decode	back to summary
public final CharBuffer decode(byte[] bytes, int start, int length)

encode	back to summary
public final ByteBuffer encode(String str)

encode	back to summary
public final ByteBuffer encode(CharSequence str)

public Class RubyEncoding

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class RubyEncoding.RawCoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class RubyEncoding.UTF8Coder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail