Package org.jruby

Class RubyEncoding

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyEncoding

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, Constantizable, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class RubyEncoding
extends RubyObject
implements Constantizable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	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.

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	CHAR_THRESHOLD	The maximum number of characters we can encode/decode in our cached buffers
private final Object	constant
private org.jcodings.Encoding	encoding
static final ByteList	EXTERNAL
static final ByteList	FILESYSTEM
static final ByteList	INTERNAL
private final boolean	isDummy
static final Charset	ISO
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.
static final Charset	UTF16
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.

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RubyEncoding(Ruby runtime, byte[] name, int p, int end, boolean isDummy)
private	RubyEncoding(Ruby runtime, byte[] name, org.jcodings.Encoding encoding, boolean isDummy)
private	RubyEncoding(Ruby runtime, ByteList name, org.jcodings.Encoding encoding, boolean isDummy)

Method Summary

Modifier and Type	Method	Description
IRubyObject	_dump(ThreadContext context, IRubyObject arg)
static IRubyObject	_load(ThreadContext context, IRubyObject recv, IRubyObject str)
static IRubyObject	aliases(ThreadContext context, IRubyObject recv)
static org.jcodings.Encoding	areCompatible(org.jcodings.Encoding enc1, int cr1, org.jcodings.Encoding enc2, int cr2)
static org.jcodings.Encoding	areCompatible(IRubyObject obj1, IRubyObject obj2)
IRubyObject	asciiCompatible_p(ThreadContext context)
static IRubyObject	compatible_p(ThreadContext context, IRubyObject self, IRubyObject first, IRubyObject second)
Object	constant()
static RubyClass	createEncodingClass(Ruby runtime)
static String	decode(byte[] bytes, int start, int length, Charset charset)
static String	decode(byte[] bytes, Charset charset)
static String	decodeISO(byte[] bytes, int start, int length)	Deprecated. use decodeRaw(byte[], int, int)
static String	decodeISO(ByteList byteList)	Deprecated. use decodeRaw(ByteList)
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.
static String	decodeRaw(ByteList byteList)	Decode the specified bytelist as "raw" binary content.
private static char[]	decodeRawLoop(byte[] s, int start, int length)
static String	decodeUTF8(byte[] bytes)
static String	decodeUTF8(byte[] bytes, int start, int length)	Decode the range of bytes specified as UTF-8 content.
(package private) static ByteList	doEncode(CharSequence cs, Charset charset, org.jcodings.Encoding enc)
(package private) static ByteList	doEncode(String cs, Charset charset, org.jcodings.Encoding enc)
(package private) static ByteList	doEncodeUTF16(CharSequence str)
(package private) static ByteList	doEncodeUTF16(String str)
(package private) static ByteList	doEncodeUTF8(CharSequence str)
(package private) static ByteList	doEncodeUTF8(String str)
IRubyObject	dummy_p(ThreadContext context)
static byte[]	encode(CharSequence cs, Charset charset)
static byte[]	encode(String str, Charset charset)
static byte[]	encodeISO(char[] str)
static byte[]	encodeISO(CharSequence str)
private static byte[]	encodeISOLoop(char[] s)
private static byte[]	encodeISOLoop(CharSequence s)
static byte[]	encodeUTF16(CharSequence str)
static byte[]	encodeUTF16(String str)
static byte[]	encodeUTF8(CharSequence str)
static byte[]	encodeUTF8(String str)
private static org.jcodings.Encoding	extractEncodingFromObject(IRubyObject obj)
static IRubyObject	find(ThreadContext context, IRubyObject recv, IRubyObject str)
private static ByteList	getByteList(ByteBuffer buffer, org.jcodings.Encoding enc, boolean shared)
private static byte[]	getBytes(ByteBuffer buffer)
static IRubyObject	getDefaultExternal(ThreadContext context, IRubyObject recv)
static IRubyObject	getDefaultInternal(IRubyObject recv)	Deprecated.
static IRubyObject	getDefaultInternal(ThreadContext context, IRubyObject recv)
final org.jcodings.Encoding	getEncoding()
private static RubyEncoding.RawCoder	getRawCoder()
private static RubyEncoding.UTF8Coder	getUTF8Coder()
IRubyObject	inspect(ThreadContext context)
static IRubyObject	list(ThreadContext context, IRubyObject recv)
static IRubyObject	locale_charmap(ThreadContext context, IRubyObject recv)
static IRubyObject	name_list(ThreadContext context, IRubyObject recv)
IRubyObject	names(ThreadContext context)
static RubyEncoding	newEncoding(Ruby runtime, byte[] name, int p, int end, boolean isDummy)
IRubyObject	replicate(ThreadContext context, IRubyObject arg)
static IRubyObject	setDefaultExternal(ThreadContext context, IRubyObject recv, IRubyObject encoding)
static IRubyObject	setDefaultInternal(ThreadContext context, IRubyObject recv, IRubyObject encoding)
IRubyObject	to_s(ThreadContext context)
private static CharBuffer	toCharBuffer(CharSequence str)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, dig1, dig2, eqlInternal, equalInternal, equals, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, defaultToJava, display, dup, ensureInstanceVariablesSettable, eql, eql_p, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, infectBy, infectBy, initialize, initialize_copy, initialize19, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method, method_missing, method_missing19, method19, methods, methods, methods19, methodsImpl, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, recacheBuiltinMethods, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, toJava, trust, type, type_deprecated, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

UTF8

public static final Charset UTF8

UTF16

public static final Charset UTF16

ISO

public static final Charset ISO

LOCALE

public static final ByteList LOCALE

EXTERNAL

public static final ByteList EXTERNAL

FILESYSTEM

public static final ByteList FILESYSTEM

INTERNAL

public static final ByteList INTERNAL

encoding

private org.jcodings.Encoding encoding

name

private final ByteList name

isDummy

private final boolean isDummy

constant

private final transient Object constant

CHAR_THRESHOLD

private static final int CHAR_THRESHOLD

The maximum number of characters we can encode/decode in our cached buffers

See Also:

• Constant Field Values

UTF8_CODER

private static final ThreadLocal<SoftReference<RubyEncoding.UTF8Coder>> UTF8_CODER

Thread-local UTF8Coder wrapped in a SoftReference to avoid possible ClassLoader leak. See JRUBY-6522

RAW_CODER

private static final ThreadLocal<SoftReference<RubyEncoding.RawCoder>> RAW_CODER

Thread-local RawCoder wrapped in a SoftReference to avoid possible ClassLoader leak. See JRUBY-6522

Constructor Details

RubyEncoding

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

RubyEncoding

private RubyEncoding(Ruby runtime,
 byte[] name,
 org.jcodings.Encoding encoding,
 boolean isDummy)

RubyEncoding

private RubyEncoding(Ruby runtime,
 ByteList name,
 org.jcodings.Encoding encoding,
 boolean isDummy)

Method Details

createEncodingClass

public static RubyClass createEncodingClass(Ruby runtime)

constant

public Object constant()

Specified by:

constant in interface Constantizable

See Also:

• Constantizable

newEncoding

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

getEncoding

public final org.jcodings.Encoding getEncoding()

extractEncodingFromObject

private static org.jcodings.Encoding extractEncodingFromObject(IRubyObject obj)

areCompatible

public static org.jcodings.Encoding areCompatible(IRubyObject obj1,
 IRubyObject obj2)

areCompatible

public static org.jcodings.Encoding areCompatible(org.jcodings.Encoding enc1,
 int cr1,
 org.jcodings.Encoding enc2,
 int cr2)

encodeUTF8

public static byte[] encodeUTF8(String str)

encodeUTF8

public static byte[] encodeUTF8(CharSequence str)

encodeISO

public static byte[] encodeISO(CharSequence str)

encodeISO

public static byte[] encodeISO(char[] str)

encodeISOLoop

private static byte[] encodeISOLoop(char[] s)

encodeISOLoop

private static byte[] encodeISOLoop(CharSequence s)

doEncodeUTF8

static ByteList doEncodeUTF8(String str)

doEncodeUTF8

static ByteList doEncodeUTF8(CharSequence str)

toCharBuffer

private static CharBuffer toCharBuffer(CharSequence str)

getBytes

private static byte[] getBytes(ByteBuffer buffer)

getByteList

private static ByteList getByteList(ByteBuffer buffer,
 org.jcodings.Encoding enc,
 boolean shared)

encodeUTF16

public static byte[] encodeUTF16(String str)

encodeUTF16

public static byte[] encodeUTF16(CharSequence str)

doEncodeUTF16

static ByteList doEncodeUTF16(String str)

doEncodeUTF16

static ByteList doEncodeUTF16(CharSequence str)

encode

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

doEncode

static ByteList doEncode(String cs,
 Charset charset,
 org.jcodings.Encoding enc)

doEncode

static ByteList doEncode(CharSequence cs,
 Charset charset,
 org.jcodings.Encoding enc)

encode

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

decodeUTF8

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 - the byte array

start - start of content

length - length of content

Returns:

a decoded String based on UTF-8 bytes

decodeRaw

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 - the byte array

start - start of content

length - length of content

Returns:

a decoded String based on raw bytes

decodeRaw

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.

Parameters:

byteList -

Returns:

a decoded string based on raw bytes

decodeRawLoop

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

decodeUTF8

public static String decodeUTF8(byte[] bytes)

decode

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

decode

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

getUTF8Coder

private static RubyEncoding.UTF8Coder getUTF8Coder()

getRawCoder

private static RubyEncoding.RawCoder getRawCoder()

list

public static IRubyObject list(ThreadContext context,
 IRubyObject recv)

locale_charmap

public static IRubyObject locale_charmap(ThreadContext context,
 IRubyObject recv)

name_list

public static IRubyObject name_list(ThreadContext context,
 IRubyObject recv)

aliases

public static IRubyObject aliases(ThreadContext context,
 IRubyObject recv)

find

public static IRubyObject find(ThreadContext context,
 IRubyObject recv,
 IRubyObject str)

replicate

public IRubyObject replicate(ThreadContext context,
 IRubyObject arg)

_dump

public IRubyObject _dump(ThreadContext context,
 IRubyObject arg)

_load

public static IRubyObject _load(ThreadContext context,
 IRubyObject recv,
 IRubyObject str)

asciiCompatible_p

public IRubyObject asciiCompatible_p(ThreadContext context)

to_s

public IRubyObject to_s(ThreadContext context)

inspect

public IRubyObject inspect(ThreadContext context)

names

public IRubyObject names(ThreadContext context)

dummy_p

public IRubyObject dummy_p(ThreadContext context)

compatible_p

public static IRubyObject compatible_p(ThreadContext context,
 IRubyObject self,
 IRubyObject first,
 IRubyObject second)

getDefaultExternal

public static IRubyObject getDefaultExternal(ThreadContext context,
 IRubyObject recv)

setDefaultExternal

public static IRubyObject setDefaultExternal(ThreadContext context,
 IRubyObject recv,
 IRubyObject encoding)

getDefaultInternal

public static IRubyObject getDefaultInternal(ThreadContext context,
 IRubyObject recv)

getDefaultInternal

@Deprecated
public static IRubyObject getDefaultInternal(IRubyObject recv)

Deprecated.

setDefaultInternal

public static IRubyObject setDefaultInternal(ThreadContext context,
 IRubyObject recv,
 IRubyObject encoding)

decodeISO

@Deprecated
public static String decodeISO(byte[] bytes,
 int start,
 int length)

Deprecated.

use decodeRaw(byte[], int, int)

decodeISO

@Deprecated
public static String decodeISO(ByteList byteList)

Deprecated.

use decodeRaw(ByteList)