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

Methods

Modifier and Type	Method and Description
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	checkIntegerType(Ruby runtime, IRubyObject obj, String method)
static String	convertToIdentifier(IRubyObject obj) Convert the supplied object into an internal identifier String.
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	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	convertToTypeOrRaise(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(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	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	handleUncoercibleObject(boolean raise, IRubyObject obj, RubyClass target)
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

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

Deprecated.

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

Parameters:

obj - the object to convert

targetType - is the type we are trying to convert to

convertMethodIndex - the fast index to use for calling the method

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

raiseOnError - will throw an Error if conversion does not work

Returns:

the converted value

convertToType

public static final 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

targetType - is the type we are trying to convert to

convertMethodIndex - the fast index to use for calling the method

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

raiseOnError - will throw an Error if conversion does not work

Returns:

the converted value

convertToType19

public static final 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

targetType - is the type we are trying to convert to

convertMethodIndex - the fast index to use for calling the method

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

raiseOnError - will throw an Error if conversion does not work

Returns:

the converted value

convertToType

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

Deprecated.

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

targetType - is the type we are trying to convert to

convertMethodIndex - the fast index to use for calling the method

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

Returns:

the converted value

convertToType

public static final 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

targetType - 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 final 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

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

toFloat

public static RubyNumeric toFloat(Ruby runtime,
                  IRubyObject obj)

checkData

public static final 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

convertToIdentifier

public static String convertToIdentifier(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.

convertToTypeWithCheck

@Deprecated
public static final IRubyObject convertToTypeWithCheck(IRubyObject obj,
                                            RubyClass target,
                                            int convertMethodIndex,
                                            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

targetType - is the type we are trying to convert to

convertMethodIndex - the fast index to use for calling the method

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

Returns:

the converted value

convertToTypeWithCheck

public static final 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

targetType - is the type we are trying to convert to

convertMethodIndex - the fast index to use for calling the method

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

Returns:

the converted value

convertToTypeWithCheck19

public static final 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

targetType - is the type we are trying to convert to

convertMethodIndex - the fast index to use for calling the method

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

Returns:

the converted value

convertToTypeOrRaise

public static final IRubyObject convertToTypeOrRaise(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

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

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)

handleUncoercibleObject

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

Throws:

RaiseException