org.jruby.util.encoding

Class CharsetTranscoder

java.lang.Object

org.jruby.util.encoding.Transcoder

org.jruby.util.encoding.CharsetTranscoder

public class CharsetTranscoder
extends Transcoder

Encapsulate all logic associated with using Java Charset transcoding facilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CharsetTranscoder.CodingActions
class	CharsetTranscoder.TranscoderEngine

Field Summary

Fields

Modifier and Type	Field and Description
static Set<Charset>	UNICODE_CHARSETS
static String[]	XMLAttrCharacterTranslator
static String[]	XMLTextCharacterTranslator

Fields inherited from class org.jruby.util.encoding.Transcoder

inEncoding, lastResult, outEncoding, runtime

Constructor Summary

Constructors

Constructor and Description
CharsetTranscoder(ThreadContext context, org.jcodings.Encoding outEncoding, org.jcodings.Encoding inEncoding)
CharsetTranscoder(ThreadContext context, org.jcodings.Encoding outEncoding, org.jcodings.Encoding inEncoding, CharsetTranscoder.CodingActions actions)
CharsetTranscoder(ThreadContext context, org.jcodings.Encoding outEncoding, org.jcodings.Encoding inEncoding, int flags, IRubyObject replace)

Method Summary

Methods

Modifier and Type	Method and Description
org.jruby.util.ByteList	convert(ThreadContext context, org.jruby.util.ByteList value, boolean is7BitASCII)
org.jruby.util.ByteList	econvStrConvert(ThreadContext context, org.jruby.util.ByteList value, boolean finish)
org.jruby.util.ByteList	finish(org.jcodings.Encoding altEncoding)
CharsetTranscoder.CodingActions	getCodingErrorActions()
RaiseException	getLastError()
RubyCoderResult	getLastResult()
String	getReplaceWith()
static CharsetTranscoder	open(ThreadContext context, byte[] sourceEncoding, byte[] destinationEncoding, int flags, IRubyObject replace)
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 CharsetTranscoder.CodingActions	processCodingErrorActions(ThreadContext context, int flags, IRubyObject replace)
static CharsetTranscoder.CodingActions	processCodingErrorActions(ThreadContext context, IRubyObject opts)
static String	stringFromCoderResult(CoderResult coderResult, int flags)
static org.jruby.util.ByteList	strTranscode(ThreadContext context, RubyString self, org.jcodings.Encoding fromEncoding, org.jcodings.Encoding toEncoding, IRubyObject opt)
static org.jruby.util.ByteList	strTranscode0(ThreadContext context, RubyString self, org.jcodings.Encoding senc, org.jcodings.Encoding denc, int ecflags, IRubyObject ecopts)
org.jruby.util.ByteList	transcode(ThreadContext context, org.jruby.util.ByteList value)
org.jruby.util.ByteList	transcode(ThreadContext context, org.jruby.util.ByteList value, boolean is7BitASCII)
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) This will try and transcode the supplied ByteList to the supplied toEncoding.
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)
static Charset	transcodeCharsetFor(Ruby runtime, byte[] name, org.jcodings.Encoding encoding, boolean is7Bit)

Methods inherited from class org.jruby.util.encoding.Transcoder

open0, strConvEnc, strConvEncOpts

Methods inherited from class java.lang.Object

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

Field Detail

XMLTextCharacterTranslator

public static final String[] XMLTextCharacterTranslator

XMLAttrCharacterTranslator

public static final String[] XMLAttrCharacterTranslator

UNICODE_CHARSETS

public static final Set<Charset> UNICODE_CHARSETS

Constructor Detail

CharsetTranscoder

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

CharsetTranscoder

public CharsetTranscoder(ThreadContext context,
                 org.jcodings.Encoding outEncoding,
                 org.jcodings.Encoding inEncoding,
                 int flags,
                 IRubyObject replace)

CharsetTranscoder

public CharsetTranscoder(ThreadContext context,
                 org.jcodings.Encoding outEncoding,
                 org.jcodings.Encoding inEncoding,
                 CharsetTranscoder.CodingActions actions)

Method Detail

open

public static CharsetTranscoder open(ThreadContext context,
                     byte[] sourceEncoding,
                     byte[] destinationEncoding,
                     int flags,
                     IRubyObject replace)

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)

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

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)

strTranscode

public static org.jruby.util.ByteList strTranscode(ThreadContext context,
                                   RubyString self,
                                   org.jcodings.Encoding fromEncoding,
                                   org.jcodings.Encoding toEncoding,
                                   IRubyObject opt)

strTranscode0

public static org.jruby.util.ByteList strTranscode0(ThreadContext context,
                                    RubyString self,
                                    org.jcodings.Encoding senc,
                                    org.jcodings.Encoding denc,
                                    int ecflags,
                                    IRubyObject ecopts)

transcode

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

Specified by:

transcode in class Transcoder

transcode

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

Specified by:

transcode in class Transcoder

transcode

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

Specified by:

transcode in class Transcoder

convert

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

Specified by:

convert in class Transcoder

econvStrConvert

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

Specified by:

econvStrConvert in class Transcoder

primitiveConvert

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

Specified by:

primitiveConvert in class Transcoder

finish

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

Specified by:

finish in class Transcoder

getLastResult

public RubyCoderResult getLastResult()

Overrides:

getLastResult in class Transcoder

getLastError

public RaiseException getLastError()

Overrides:

getLastError in class Transcoder

getReplaceWith

public String getReplaceWith()

stringFromCoderResult

public static String stringFromCoderResult(CoderResult coderResult,
                           int flags)

getCodingErrorActions

public CharsetTranscoder.CodingActions getCodingErrorActions()

processCodingErrorActions

public static CharsetTranscoder.CodingActions processCodingErrorActions(ThreadContext context,
                                                        int flags,
                                                        IRubyObject replace)

processCodingErrorActions

public static CharsetTranscoder.CodingActions processCodingErrorActions(ThreadContext context,
                                                        IRubyObject opts)

transcodeCharsetFor

public static Charset transcodeCharsetFor(Ruby runtime,
                          byte[] name,
                          org.jcodings.Encoding encoding,
                          boolean is7Bit)