org.jruby.runtime.marshal

Class MarshalStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.jruby.runtime.marshal.MarshalStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class MarshalStream
extends java.io.FilterOutputStream

Marshals objects into Ruby's binary marshal format.

Field Summary

Fields

Modifier and Type	Field and Description
private MarshalCache	cache
private int	depth
private int	depthLimit
private Ruby	runtime
private static java.lang.String	SYMBOL_ENCODING
static java.lang.String	SYMBOL_ENCODING_SPECIAL
private boolean	tainted
private static char	TYPE_IVAR
private static char	TYPE_UCLASS
private static char	TYPE_USERDEF
private static char	TYPE_USRMARSHAL
private boolean	untrusted

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
MarshalStream(Ruby runtime, java.io.OutputStream out, int depthLimit)

Method Summary

Modifier and Type	Method and Description
void	dumpDefaultObjectHeader(char tp, RubyClass type)
void	dumpDefaultObjectHeader(RubyClass type)
private RubyClass	dumpExtended(RubyClass type) w_extended
void	dumpObject(IRubyObject value)
void	dumpSymbol(java.lang.String value)
void	dumpVariables(java.util.List<Variable<java.lang.Object>> vars)
private void	dumpVariablesShared(java.util.List<Variable<java.lang.Object>> vars)
void	dumpVariablesWithEncoding(java.util.List<Variable<java.lang.Object>> vars, IRubyObject obj)
static java.lang.String	getPathFromClass(RubyModule clazz)
private java.util.List<Variable<java.lang.Object>>	getVariables(IRubyObject value)
private boolean	hasSingletonMethods(RubyClass type)
private static boolean	isMarshalFixnum(RubyFixnum fixnum)
boolean	isTainted()
boolean	isUntrusted()
void	registerLinkTarget(IRubyObject newObject)
void	registerSymbol(java.lang.String sym)
(package private) static boolean	shouldBeRegistered(IRubyObject value)
private boolean	shouldMarshalEncoding(IRubyObject value)
private void	userCommon(IRubyObject value, DynamicMethod method)
void	userMarshal(IRubyObject value)
void	userMarshal(IRubyObject value, DynamicMethod method)
private void	userNewCommon(IRubyObject value, DynamicMethod method)
void	userNewMarshal(IRubyObject value)
void	userNewMarshal(IRubyObject value, DynamicMethod method)
private void	writeAndRegister(IRubyObject value)
private void	writeAndRegisterSymbol(java.lang.String sym)
void	writeByte(int value)
void	writeDirectly(IRubyObject value)
void	writeEncoding(org.jcodings.Encoding encoding)
void	writeInt(int value)
private void	writeObjectData(IRubyObject value)
void	writeString(org.jruby.util.ByteList value)
void	writeString(java.lang.String value)
void	writeUserClass(IRubyObject obj, RubyClass type)

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

runtime

private final Ruby runtime

cache

private final MarshalCache cache

depthLimit

private final int depthLimit

tainted

private boolean tainted

untrusted

private boolean untrusted

depth

private int depth

TYPE_IVAR

private static final char TYPE_IVAR

See Also:

Constant Field Values

TYPE_USRMARSHAL

private static final char TYPE_USRMARSHAL

See Also:

Constant Field Values

TYPE_USERDEF

private static final char TYPE_USERDEF

See Also:

Constant Field Values

TYPE_UCLASS

private static final char TYPE_UCLASS

See Also:

Constant Field Values

SYMBOL_ENCODING_SPECIAL

public static final java.lang.String SYMBOL_ENCODING_SPECIAL

See Also:

Constant Field Values

SYMBOL_ENCODING

private static final java.lang.String SYMBOL_ENCODING

See Also:

Constant Field Values

Constructor Detail

MarshalStream

public MarshalStream(Ruby runtime,
                     java.io.OutputStream out,
                     int depthLimit)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

dumpObject

public void dumpObject(IRubyObject value)
                throws java.io.IOException

Throws:

java.io.IOException

registerLinkTarget

public void registerLinkTarget(IRubyObject newObject)

registerSymbol

public void registerSymbol(java.lang.String sym)

shouldBeRegistered

static boolean shouldBeRegistered(IRubyObject value)

isMarshalFixnum

private static boolean isMarshalFixnum(RubyFixnum fixnum)

writeAndRegisterSymbol

private void writeAndRegisterSymbol(java.lang.String sym)
                             throws java.io.IOException

Throws:

java.io.IOException

writeAndRegister

private void writeAndRegister(IRubyObject value)
                       throws java.io.IOException

Throws:

java.io.IOException

getVariables

private java.util.List<Variable<java.lang.Object>> getVariables(IRubyObject value)
                                                         throws java.io.IOException

Throws:

java.io.IOException

shouldMarshalEncoding

private boolean shouldMarshalEncoding(IRubyObject value)

writeDirectly

public void writeDirectly(IRubyObject value)
                   throws java.io.IOException

Throws:

java.io.IOException

getPathFromClass

public static java.lang.String getPathFromClass(RubyModule clazz)

writeObjectData

private void writeObjectData(IRubyObject value)
                      throws java.io.IOException

Throws:

java.io.IOException

userNewMarshal

public void userNewMarshal(IRubyObject value,
                           DynamicMethod method)
                    throws java.io.IOException

Throws:

java.io.IOException

userNewMarshal

public void userNewMarshal(IRubyObject value)
                    throws java.io.IOException

Throws:

java.io.IOException

userNewCommon

private void userNewCommon(IRubyObject value,
                           DynamicMethod method)
                    throws java.io.IOException

Throws:

java.io.IOException

userMarshal

public void userMarshal(IRubyObject value,
                        DynamicMethod method)
                 throws java.io.IOException

Throws:

java.io.IOException

userMarshal

public void userMarshal(IRubyObject value)
                 throws java.io.IOException

Throws:

java.io.IOException

userCommon

private void userCommon(IRubyObject value,
                        DynamicMethod method)
                 throws java.io.IOException

Throws:

java.io.IOException

writeUserClass

public void writeUserClass(IRubyObject obj,
                           RubyClass type)
                    throws java.io.IOException

Throws:

java.io.IOException

dumpVariablesWithEncoding

public void dumpVariablesWithEncoding(java.util.List<Variable<java.lang.Object>> vars,
                                      IRubyObject obj)
                               throws java.io.IOException

Throws:

java.io.IOException

dumpVariables

public void dumpVariables(java.util.List<Variable<java.lang.Object>> vars)
                   throws java.io.IOException

Throws:

java.io.IOException

dumpVariablesShared

private void dumpVariablesShared(java.util.List<Variable<java.lang.Object>> vars)
                          throws java.io.IOException

Throws:

java.io.IOException

writeEncoding

public void writeEncoding(org.jcodings.Encoding encoding)
                   throws java.io.IOException

Throws:

java.io.IOException

hasSingletonMethods

private boolean hasSingletonMethods(RubyClass type)

dumpExtended

private RubyClass dumpExtended(RubyClass type)
                        throws java.io.IOException

w_extended

Throws:

java.io.IOException

dumpDefaultObjectHeader

public void dumpDefaultObjectHeader(RubyClass type)
                             throws java.io.IOException

Throws:

java.io.IOException

dumpDefaultObjectHeader

public void dumpDefaultObjectHeader(char tp,
                                    RubyClass type)
                             throws java.io.IOException

Throws:

java.io.IOException

writeString

public void writeString(java.lang.String value)
                 throws java.io.IOException

Throws:

java.io.IOException

writeString

public void writeString(org.jruby.util.ByteList value)
                 throws java.io.IOException

Throws:

java.io.IOException

dumpSymbol

public void dumpSymbol(java.lang.String value)
                throws java.io.IOException

Throws:

java.io.IOException

writeInt

public void writeInt(int value)
              throws java.io.IOException

Throws:

java.io.IOException

writeByte

public void writeByte(int value)
               throws java.io.IOException

Throws:

java.io.IOException

isTainted

public boolean isTainted()

isUntrusted

public boolean isUntrusted()