org.jruby.util

Class TypeConverter

java.lang.Object

org.jruby.util.TypeConverter

public class TypeConverter
extends Object

Constructor Summary

Constructors

Constructor and Description
TypeConverter()

Method Summary

Modifier and Type	Method and Description
static IRubyObject	checkArrayType(IRubyObject self)
static IRubyObject	checkArrayType(Ruby runtime, IRubyObject obj)
static IRubyObject	checkArrayType(ThreadContext context, JavaSites.CheckedSites sites, IRubyObject obj)
static IRubyObject	checkData(IRubyObject obj) Checks that this object is of type DATA and then returns it, otherwise raises failure (MRI: Check_Type(obj, T_DATA))
static IRubyObject	checkFloatType(Ruby runtime, IRubyObject obj)
static IRubyObject	checkHashType(Ruby runtime, IRubyObject obj)
static IRubyObject	checkHashType(ThreadContext context, JavaSites.CheckedSites sites, IRubyObject obj)
static RubySymbol	checkID(IRubyObject obj) Convert the supplied object into an internal identifier String.
static RubySymbol	checkID(Ruby runtime, String name) Convert the supplied object into an internal identifier String.
static IRubyObject	checkIntegerType(Ruby runtime, IRubyObject obj, String method)
static IRubyObject	checkIntegerType(ThreadContext context, IRubyObject obj)
static IRubyObject	checkStringType(Ruby runtime, IRubyObject obj)
static IRubyObject	checkStringType(ThreadContext context, JavaSites.CheckedSites sites, IRubyObject obj)
static IRubyObject	checkStringType(ThreadContext context, JavaSites.CheckedSites sites, IRubyObject obj, RubyClass target)
static void	checkType(ThreadContext context, IRubyObject x, RubyModule t)
static String	convertToIdentifier(IRubyObject obj) Deprecated.
static IRubyObject	convertToInteger(ThreadContext context, IRubyObject val, int base)
static IRubyObject	convertToType(IRubyObject obj, RubyClass target, int convertMethodIndex, String convertMethod) Deprecated.
static IRubyObject	convertToType(IRubyObject obj, RubyClass target, int convertMethodIndex, String convertMethod, boolean raise) Deprecated.
static IRubyObject	convertToType(IRubyObject obj, RubyClass target, String convertMethod) Converts this object to type 'targetType' using 'convertMethod' method and raises TypeError exception on failure (MRI: rb_convert_type).
static IRubyObject	convertToType(IRubyObject obj, RubyClass target, String convertMethod, boolean raise) Converts this object to type 'targetType' using 'convertMethod' method (MRI: convert_type).
static IRubyObject	convertToType(ThreadContext context, IRubyObject obj, RubyClass target, JavaSites.CheckedSites sites) Converts this object to type 'targetType' using 'convertMethod' method and raises TypeError exception on failure (MRI: rb_convert_type).
static IRubyObject	convertToType(ThreadContext context, IRubyObject obj, RubyClass target, JavaSites.CheckedSites sites, boolean raise)
static IRubyObject	convertToType19(IRubyObject obj, RubyClass target, String convertMethod) Converts this object to type 'targetType' using 'convertMethod' method and raises TypeError exception on failure (MRI: rb_convert_type in 1.9).
static IRubyObject	convertToType19(IRubyObject obj, RubyClass target, String convertMethod, boolean raise) Converts this object to type 'targetType' using 'convertMethod' method (MRI: convert_type 1.9).
static IRubyObject	convertToType19(ThreadContext context, IRubyObject obj, RubyClass target, JavaSites.CheckedSites sites) Converts this object to type 'targetType' using 'convertMethod' method and raises TypeError exception on failure (MRI: rb_convert_type in 1.9).
static IRubyObject	convertToType19(ThreadContext context, IRubyObject obj, RubyClass target, JavaSites.CheckedSites sites, boolean raise) Converts this object to type 'targetType' using 'convertMethod' method (MRI: convert_type 1.9).
static IRubyObject	convertToTypeOrRaise(IRubyObject obj, RubyClass target, String convertMethod) Deprecated.
static IRubyObject	convertToTypeWithCheck(IRubyObject obj, RubyClass target, int convertMethodIndex, String convertMethod) Deprecated.
static IRubyObject	convertToTypeWithCheck(IRubyObject obj, RubyClass target, String convertMethod) Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).
static IRubyObject	convertToTypeWithCheck(ThreadContext context, IRubyObject obj, RubyClass target, JavaSites.CheckedSites sites) Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).
static IRubyObject	convertToTypeWithCheck19(IRubyObject obj, RubyClass target, String convertMethod) Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).
static IRubyObject	convertToTypeWithCheck19(ThreadContext context, IRubyObject obj, RubyClass target, JavaSites.CheckedSites sites) Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).
static IRubyObject	handleImplicitlyUncoercibleObject(boolean raise, IRubyObject obj, RubyClass target)
static IRubyObject	handleUncoercibleObject(boolean raise, IRubyObject obj, RubyClass target)
static IRubyObject	ioCheckIO(Ruby runtime, IRubyObject obj)
static RubyIO	ioGetIO(Ruby runtime, IRubyObject obj)
static RaiseException	newTypeError(IRubyObject obj, RubyClass target, String convertMethod, IRubyObject val)
static RubyArray	rb_Array(ThreadContext context, IRubyObject val)
static RubyArray	to_ary(ThreadContext context, IRubyObject ary)
static RubyNumeric	toFloat(Ruby runtime, IRubyObject obj)

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeConverter

public TypeConverter()

Method Detail

convertToType

public static IRubyObject convertToType(IRubyObject obj,
                                        RubyClass target,
                                        String convertMethod,
                                        boolean raise)

Converts this object to type 'targetType' using 'convertMethod' method (MRI: convert_type).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

convertMethod - is the method to be called to try and convert to targeType

raise - will throw an Error if conversion does not work

Returns:

the converted value

convertToType

public static IRubyObject convertToType(ThreadContext context,
                                        IRubyObject obj,
                                        RubyClass target,
                                        JavaSites.CheckedSites sites,
                                        boolean raise)

convertToType19

public static IRubyObject convertToType19(IRubyObject obj,
                                          RubyClass target,
                                          String convertMethod,
                                          boolean raise)

Converts this object to type 'targetType' using 'convertMethod' method (MRI: convert_type 1.9).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

convertMethod - is the method to be called to try and convert to targeType

raise - will throw an Error if conversion does not work

Returns:

the converted value

convertToType19

public static IRubyObject convertToType19(ThreadContext context,
                                          IRubyObject obj,
                                          RubyClass target,
                                          JavaSites.CheckedSites sites,
                                          boolean raise)

Converts this object to type 'targetType' using 'convertMethod' method (MRI: convert_type 1.9).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

sites - is the CheckedSites call sites to be called to try and convert to targetType

raise - will throw an Error if conversion does not work

Returns:

the converted value

convertToType

public static IRubyObject convertToType(IRubyObject obj,
                                        RubyClass target,
                                        String convertMethod)

Converts this object to type 'targetType' using 'convertMethod' method and raises TypeError exception on failure (MRI: rb_convert_type).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

convertMethod - is the method to be called to try and convert to targeType

Returns:

the converted value

convertToType

public static IRubyObject convertToType(ThreadContext context,
                                        IRubyObject obj,
                                        RubyClass target,
                                        JavaSites.CheckedSites sites)

Converts this object to type 'targetType' using 'convertMethod' method and raises TypeError exception on failure (MRI: rb_convert_type).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

sites - is the CheckedSites call sites to use to dispatch the convert method

Returns:

the converted value

convertToType19

public static IRubyObject convertToType19(IRubyObject obj,
                                          RubyClass target,
                                          String convertMethod)

Converts this object to type 'targetType' using 'convertMethod' method and raises TypeError exception on failure (MRI: rb_convert_type in 1.9).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

convertMethod - is the method to be called to try and convert to targeType

Returns:

the converted value

convertToType19

public static IRubyObject convertToType19(ThreadContext context,
                                          IRubyObject obj,
                                          RubyClass target,
                                          JavaSites.CheckedSites sites)

Converts this object to type 'targetType' using 'convertMethod' method and raises TypeError exception on failure (MRI: rb_convert_type in 1.9).

Parameters:

context - the current context

obj - the object to convert

target - is the type we are trying to convert to

sites - the CheckedSites call sites to use for coersion

Returns:

the converted value

toFloat

public static RubyNumeric toFloat(Ruby runtime,
                                  IRubyObject obj)

checkData

public static IRubyObject checkData(IRubyObject obj)

Checks that this object is of type DATA and then returns it, otherwise raises failure (MRI: Check_Type(obj, T_DATA))

Parameters:

obj - the object to check

Returns:

the converted value

checkID

public static RubySymbol checkID(IRubyObject obj)

Convert the supplied object into an internal identifier String. Basically, symbols are stored internally as raw bytes from whatever encoding they were originally sourced from. When methods are stored they must also get stored in this same raw fashion so that if we use symbols to look up methods or make symbols from these method names they will match up. For 2.2 compatibility, we also force all incoming identifiers to get anchored as hard-referenced symbols.

checkID

public static RubySymbol checkID(Ruby runtime,
                                 String name)

Convert the supplied object into an internal identifier String. Basically, symbols are stored internally as raw bytes from whatever encoding they were originally sourced from. When methods are stored they must also get stored in this same raw fashion so that if we use symbols to look up methods or make symbols from these method names they will match up. For 2.2 compatibility, we also force all incoming identifiers to get anchored as hard-referenced symbols.

convertToTypeWithCheck

public static IRubyObject convertToTypeWithCheck(IRubyObject obj,
                                                 RubyClass target,
                                                 String convertMethod)

Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

convertMethod - is the method to be called to try and convert to targeType

Returns:

the converted value

convertToTypeWithCheck

public static IRubyObject convertToTypeWithCheck(ThreadContext context,
                                                 IRubyObject obj,
                                                 RubyClass target,
                                                 JavaSites.CheckedSites sites)

Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

sites - the CheckedSites call sites to use for coersion

Returns:

the converted value

convertToTypeWithCheck19

public static IRubyObject convertToTypeWithCheck19(IRubyObject obj,
                                                   RubyClass target,
                                                   String convertMethod)

Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

convertMethod - is the method to be called to try and convert to targeType

Returns:

the converted value

convertToTypeWithCheck19

public static IRubyObject convertToTypeWithCheck19(ThreadContext context,
                                                   IRubyObject obj,
                                                   RubyClass target,
                                                   JavaSites.CheckedSites sites)

Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).

Parameters:

context - the current context

obj - the object to convert

target - is the type we are trying to convert to

sites - is the CheckedSites call sites to be used for coersion

Returns:

the converted value

newTypeError

public static RaiseException newTypeError(IRubyObject obj,
                                          RubyClass target,
                                          String convertMethod,
                                          IRubyObject val)

checkIntegerType

public static IRubyObject checkIntegerType(ThreadContext context,
                                           IRubyObject obj)

checkIntegerType

public static IRubyObject checkIntegerType(Ruby runtime,
                                           IRubyObject obj,
                                           String method)

checkFloatType

public static IRubyObject checkFloatType(Ruby runtime,
                                         IRubyObject obj)

checkHashType

public static IRubyObject checkHashType(Ruby runtime,
                                        IRubyObject obj)

checkHashType

public static IRubyObject checkHashType(ThreadContext context,
                                        JavaSites.CheckedSites sites,
                                        IRubyObject obj)

checkStringType

public static IRubyObject checkStringType(Ruby runtime,
                                          IRubyObject obj)

checkStringType

public static IRubyObject checkStringType(ThreadContext context,
                                          JavaSites.CheckedSites sites,
                                          IRubyObject obj)

checkStringType

public static IRubyObject checkStringType(ThreadContext context,
                                          JavaSites.CheckedSites sites,
                                          IRubyObject obj,
                                          RubyClass target)

checkArrayType

public static IRubyObject checkArrayType(Ruby runtime,
                                         IRubyObject obj)

checkArrayType

public static IRubyObject checkArrayType(ThreadContext context,
                                         JavaSites.CheckedSites sites,
                                         IRubyObject obj)

ioCheckIO

public static IRubyObject ioCheckIO(Ruby runtime,
                                    IRubyObject obj)

ioGetIO

public static RubyIO ioGetIO(Ruby runtime,
                             IRubyObject obj)

checkArrayType

public static IRubyObject checkArrayType(IRubyObject self)

handleUncoercibleObject

public static IRubyObject handleUncoercibleObject(boolean raise,
                                                  IRubyObject obj,
                                                  RubyClass target)

handleImplicitlyUncoercibleObject

public static IRubyObject handleImplicitlyUncoercibleObject(boolean raise,
                                                            IRubyObject obj,
                                                            RubyClass target)

checkType

public static void checkType(ThreadContext context,
                             IRubyObject x,
                             RubyModule t)

convertToInteger

public static IRubyObject convertToInteger(ThreadContext context,
                                           IRubyObject val,
                                           int base)

rb_Array

public static RubyArray rb_Array(ThreadContext context,
                                 IRubyObject val)

to_ary

public static RubyArray to_ary(ThreadContext context,
                               IRubyObject ary)

convertToType

@Deprecated
public static IRubyObject convertToType(IRubyObject obj,
                                                    RubyClass target,
                                                    int convertMethodIndex,
                                                    String convertMethod,
                                                    boolean raise)

Deprecated.

convertToType

@Deprecated
public static IRubyObject convertToType(IRubyObject obj,
                                                    RubyClass target,
                                                    int convertMethodIndex,
                                                    String convertMethod)

Deprecated.

convertToTypeWithCheck

@Deprecated
public static IRubyObject convertToTypeWithCheck(IRubyObject obj,
                                                             RubyClass target,
                                                             int convertMethodIndex,
                                                             String convertMethod)

Deprecated.

convertToIdentifier

@Deprecated
public static String convertToIdentifier(IRubyObject obj)

Deprecated.

convertToTypeOrRaise

@Deprecated
public static IRubyObject convertToTypeOrRaise(IRubyObject obj,
                                                           RubyClass target,
                                                           String convertMethod)

Deprecated.

Higher level conversion utility similar to convertToType but it can throw an additional TypeError during conversion (MRI: rb_check_convert_type).

Parameters:

obj - the object to convert

target - is the type we are trying to convert to

convertMethod - is the method to be called to try and convert to targeType

Returns:

the converted value