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/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
static final ByteList	BINARY_ASCII_NAME
static final ByteList	EXTERNAL
static final ByteList	FILESYSTEM
static final ByteList	INTERNAL
static final Charset	ISO
static final ByteList	LOCALE
static final Charset	UTF16
static final Charset	UTF8

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, 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

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 org.jcodings.Encoding	checkEncoding(ThreadContext context, org.jcodings.Encoding encoding, CodeRangeable other)	Check whether the given encoding and the encoding from the given CodeRangeable are compatible.
static IRubyObject	compatible_p(ThreadContext context, IRubyObject self, IRubyObject first, IRubyObject second)
Object	constant()
static RubyClass	createEncodingClass(ThreadContext context, RubyClass Object)
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.
static String	decodeUTF8(byte[] bytes)
static String	decodeUTF8(byte[] bytes, int start, int length)	Decode the range of bytes specified as UTF-8 content.
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)
static byte[]	encodeUTF16(CharSequence str)
static byte[]	encodeUTF16(String str)
static byte[]	encodeUTF8(CharSequence str)
static byte[]	encodeUTF8(String str)
static IRubyObject	find(ThreadContext context, IRubyObject recv, IRubyObject str)
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()
IRubyObject	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
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)	Deprecated.
static IRubyObject	setDefaultExternal(ThreadContext context, IRubyObject recv, IRubyObject encoding)
static IRubyObject	setDefaultInternal(ThreadContext context, IRubyObject recv, IRubyObject encoding)
IRubyObject	to_s(ThreadContext context)

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, initialize_copy, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, toJava, trust, type, 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

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

checkStringType19, dup, marshalLiveVariables

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

BINARY_ASCII_NAME

public static final ByteList BINARY_ASCII_NAME

Method Details

createEncodingClass

public static RubyClass createEncodingClass(ThreadContext context,
 RubyClass Object)

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()

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)

encodeUTF16

public static byte[] encodeUTF16(String str)

encodeUTF16

public static byte[] encodeUTF16(CharSequence str)

encode

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

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

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)

checkEncoding

public static org.jcodings.Encoding checkEncoding(ThreadContext context,
 org.jcodings.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 - the current thread context

encoding - the first encoding

other - the CodeRangeable from which to get bytes and the second encoding

Returns:

a negotiated encoding, if compatible; null otherwise

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

@Deprecated(since="10.0")
public IRubyObject replicate(ThreadContext context,
 IRubyObject arg)

Deprecated.

_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)

Overrides:

to_s in class RubyBasicObject

inspect

public IRubyObject inspect(ThreadContext context)

Description copied from class: RubyBasicObject

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"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

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)