org.jruby.util.encoding

Class Transcoder

java.lang.Object

org.jruby.util.encoding.Transcoder

Direct Known Subclasses:

CharsetTranscoder

public abstract class Transcoder
extends Object

Abstract superclass for all transcoders. This and its implementations are roughly equivalent to rb_econv_t in MRI.

Field Summary

Fields

Modifier and Type	Field and Description
org.jcodings.Encoding	inEncoding
RubyCoderResult	lastResult
org.jcodings.Encoding	outEncoding
protected Ruby	runtime
static Set<Charset>	UNICODE_CHARSETS

Constructor Summary

Constructors

Constructor and Description
Transcoder(ThreadContext context, org.jcodings.Encoding outEncoding, org.jcodings.Encoding inEncoding)

Method Summary

Modifier and Type	Method and Description
abstract org.jruby.util.ByteList	convert(ThreadContext context, org.jruby.util.ByteList value, boolean is7BitASCII)
abstract RubyCoderResult	econvConvert(ThreadContext context, org.jruby.util.ByteList value, org.jruby.util.ByteList dest)
abstract org.jruby.util.ByteList	econvStrConvert(ThreadContext context, org.jruby.util.ByteList value, boolean finish)
abstract org.jruby.util.ByteList	finish(org.jcodings.Encoding altEncoding)
RaiseException	getLastError()
RubyCoderResult	getLastResult()
static Transcoder	open(ThreadContext context, byte[] sourceEncoding, byte[] destinationEncoding, int ecflags, IRubyObject replacement)
static Transcoder	open0(ThreadContext context, byte[] sourceEncoding, byte[] destinationEncoding, int ecflags, IRubyObject replacement)
abstract RubyCoderResult	primitiveConvert(ThreadContext context, org.jruby.util.ByteList inBuffer, org.jruby.util.ByteList outBuffer, int outOffset, int outLimit, org.jcodings.Encoding inEncoding, boolean is7BitASCII, int flags)
static org.jruby.util.ByteList	strConvEnc(ThreadContext context, org.jruby.util.ByteList value, org.jcodings.Encoding fromEncoding, org.jcodings.Encoding toEncoding)
static org.jruby.util.ByteList	strConvEncOpts(ThreadContext context, org.jruby.util.ByteList value, org.jcodings.Encoding fromEncoding, org.jcodings.Encoding toEncoding, int ecflags, IRubyObject ecopts) This will try and transcode the supplied ByteList to the supplied toEncoding.
abstract org.jruby.util.ByteList	transcode(ThreadContext context, org.jruby.util.ByteList value)
abstract org.jruby.util.ByteList	transcode(ThreadContext context, org.jruby.util.ByteList value, boolean is7BitASCII)
abstract RubyCoderResult	transcode(ThreadContext context, org.jruby.util.ByteList value, org.jruby.util.ByteList dest)
static org.jruby.util.ByteList	transcode(ThreadContext context, org.jruby.util.ByteList value, org.jcodings.Encoding fromEncoding, org.jcodings.Encoding toEncoding, IRubyObject opts, boolean is7BitASCII)

Methods inherited from class java.lang.Object

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

Field Detail

runtime

protected final Ruby runtime

outEncoding

public final org.jcodings.Encoding outEncoding

inEncoding

public final org.jcodings.Encoding inEncoding

lastResult

public RubyCoderResult lastResult

UNICODE_CHARSETS

public static final Set<Charset> UNICODE_CHARSETS

Constructor Detail

Transcoder

public Transcoder(ThreadContext context,
                  org.jcodings.Encoding outEncoding,
                  org.jcodings.Encoding inEncoding)

Method Detail

open

public static Transcoder open(ThreadContext context,
                              byte[] sourceEncoding,
                              byte[] destinationEncoding,
                              int ecflags,
                              IRubyObject replacement)

open0

public static Transcoder open0(ThreadContext context,
                               byte[] sourceEncoding,
                               byte[] destinationEncoding,
                               int ecflags,
                               IRubyObject replacement)

strConvEncOpts

public static org.jruby.util.ByteList strConvEncOpts(ThreadContext context,
                                                     org.jruby.util.ByteList value,
                                                     org.jcodings.Encoding fromEncoding,
                                                     org.jcodings.Encoding toEncoding,
                                                     int ecflags,
                                                     IRubyObject ecopts)

This will try and transcode the supplied ByteList to the supplied toEncoding. It will use forceEncoding as its encoding if it is supplied; otherwise it will use the encoding it has tucked away in the bytelist. This will return a new copy of a ByteList in the request encoding or die trying (ConverterNotFound). c: rb_str_conv_enc_opts

strConvEnc

public static org.jruby.util.ByteList strConvEnc(ThreadContext context,
                                                 org.jruby.util.ByteList value,
                                                 org.jcodings.Encoding fromEncoding,
                                                 org.jcodings.Encoding toEncoding)

transcode

public static org.jruby.util.ByteList transcode(ThreadContext context,
                                                org.jruby.util.ByteList value,
                                                org.jcodings.Encoding fromEncoding,
                                                org.jcodings.Encoding toEncoding,
                                                IRubyObject opts,
                                                boolean is7BitASCII)

transcode

public abstract RubyCoderResult transcode(ThreadContext context,
                                          org.jruby.util.ByteList value,
                                          org.jruby.util.ByteList dest)

econvConvert

public abstract RubyCoderResult econvConvert(ThreadContext context,
                                             org.jruby.util.ByteList value,
                                             org.jruby.util.ByteList dest)

transcode

public abstract org.jruby.util.ByteList transcode(ThreadContext context,
                                                  org.jruby.util.ByteList value)

transcode

public abstract org.jruby.util.ByteList transcode(ThreadContext context,
                                                  org.jruby.util.ByteList value,
                                                  boolean is7BitASCII)

convert

public abstract org.jruby.util.ByteList convert(ThreadContext context,
                                                org.jruby.util.ByteList value,
                                                boolean is7BitASCII)

econvStrConvert

public abstract org.jruby.util.ByteList econvStrConvert(ThreadContext context,
                                                        org.jruby.util.ByteList value,
                                                        boolean finish)

primitiveConvert

public abstract RubyCoderResult primitiveConvert(ThreadContext context,
                                                 org.jruby.util.ByteList inBuffer,
                                                 org.jruby.util.ByteList outBuffer,
                                                 int outOffset,
                                                 int outLimit,
                                                 org.jcodings.Encoding inEncoding,
                                                 boolean is7BitASCII,
                                                 int flags)

finish

public abstract org.jruby.util.ByteList finish(org.jcodings.Encoding altEncoding)

getLastResult

public RubyCoderResult getLastResult()

getLastError

public RaiseException getLastError()