JRuby Base 10.0.0.0 · org.jruby.api.Convert · APIdia, the JavaDoc alternative

Access	Constructor and Description
public	Convert()

Method Summary

Modifier and Type	Method and Description
public static RubyBoolean	Returns: the Ruby Boolean asBoolean(ThreadContext the current thread context context, boolean the boolean value value) Create a Ruby Boolean from a java boolean.
public static RubyFixnum	Returns: the Ruby Fixnum asFixnum(ThreadContext the current thread context context, long the long value value) Create a Ruby Fixnum from a java long.
public static RubyFixnum	Returns: the Ruby Fixnum asFixnum(ThreadContext the current thread context context, int the int value value) Create a Ruby Fixnum from a java int.
public static RubyFloat	Returns: the Ruby Float asFloat(ThreadContext the current thread context context, double the double value value) Create a Ruby Float from a java double.
public static RubyFloat	Returns: the Ruby Float asFloat(ThreadContext the current thread context context, long the long value value) Create a Ruby Float from a java long.
public static RubyInteger	Returns: the result asInteger(ThreadContext the current thread context context, double the double value value) Create some type of Ruby Integer from a java double
public static RubySymbol	Returns: the new RubyString asSymbol(ThreadContext the current thread context context, String the contents to become a symbol string) Creates a new RubySymbol from the provided java String.
public static RubySymbol	Returns: the new RubyString asSymbol(ThreadContext the current thread context context, ByteList the contents to become a symbol bytelist) Creates a new RubySymbol from the provided java String.
public static RubySymbol	Returns: the new RubySymbol asSymbol(ThreadContext the current thread context context, RubyString the contents to become a symbol string) Creates a new RubySymbol from the provided java String.
public static RubyArray<T extends IRubyObject>	Returns: the value as a RubyArray castAsArray(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyArray with most basic typeError thrown if the value is not a RubyArray.
public static RubyArray<T extends IRubyObject>	Returns: the value as a RubyArray castAsArray(ThreadContext the current thread context context, IRubyObject the value to cast newValue, String the message to include in the type error message) Cast the given value to a RubyArray with most basic typeError thrown if the value is not a RubyArray.
public static RubyBignum	Returns: the value as a RubyBignum castAsBignum(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyBignum with most basic typeError thrown if the value is not a RubyBignum.
public static RubyClass	Returns: the value as a RubyClass castAsClass(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyClass with most basic typeError thrown if the value is not a RubyClass.
public static RubyFile	Returns: the value as a RubyFile castAsFile(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyFile with most basic typeError thrown if the value is not a RubyFile.
public static RubyFixnum	Returns: the value as a RubyFixnum castAsFixnum(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyFixnum with most basic typeError thrown if the value is not a RubyFixnum.
public static RubyFixnum	Returns: the value as a RubyFixnum castAsFixnum(ThreadContext the current thread context context, IRubyObject the value to cast newValue, String the message to include in the type error message) Cast the given value to a RubyFixnum with most basic typeError thrown if the value is not a RubyFixnum.
public static RubyHash	Returns: the value as a RubyHash castAsHash(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyHash with most basic typeError thrown if the value is not a RubyHash.
public static RubyHash	Returns: the value as a RubyHash castAsHash(ThreadContext the current thread context context, IRubyObject the value to cast newValue, String the message to include in the type error message) Cast the given value to a RubyHash with most basic typeError thrown if the value is not a RubyHash.
public static RubyInteger	Returns: the value as a RubyInteger castAsInteger(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyInteger with most basic typeError thrown if the value is not a RubyInteger.
public static RubyInteger	Returns: the value as a RubyInteger castAsInteger(ThreadContext the current thread context context, IRubyObject the value to cast newValue, String the message to include in the type error message) Cast the given value to a RubyInteger with most basic typeError thrown if the value is not a RubyInteger.
public static RubyModule	Returns: the value as a RubyModule castAsModule(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyModule with most basic typeError thrown if the value is not a RubyModule.
public static RubyModule	Returns: the value as a RubyModule castAsModule(ThreadContext the current thread context context, IRubyObject the value to cast newValue, String the message to include in the type error message) Cast the given value to a RubyModule with most basic typeError thrown if the value is not a RubyModule.
public static RubyNumeric	Returns: the value as a RubyNumeric castAsNumeric(ThreadContext the current thread context context, IRubyObject the value to cast newValue, String the message to include in the type error message) Cast the given value to a RubyNumeric with most basic typeError thrown if the value is not a RubyNumeric.
public static RubyProc	Returns: the value as a RubyProc castAsProc(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyProc with most basic typeError thrown if the value is not a RubyProc.
public static RubyProc	Returns: the value as a RubyProc castAsProc(ThreadContext the current thread context context, IRubyObject the value to cast newValue, String the message to include in the type error message) Cast the given value to a RubyProc with most basic typeError thrown if the value is not a RubyProc.
public static RubyRange	Returns: the value as a RubyRange castAsRange(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyRange with most basic typeError thrown if the value is not a RubyRange.
public static RubyString	Returns: the value as a RubyString castAsString(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubyString with most basic typeError thrown if the value is not a RubyString.
public static RubySymbol	Returns: the value as a RubySymbol castAsSymbol(ThreadContext the current thread context context, IRubyObject the value to cast newValue) Cast the given value to a RubySymbol with most basic typeError thrown if the value is not a RubySymbol.
public static int	Returns: the int value checkInt(ThreadContext the current thread context context, long the long to check num) Check to make sure the long num given will fit into an int.
public static IRubyObject	Returns: the integer value or nil if the object or conversion is not an Integer. checkToInteger(ThreadContext the current thread context context, IRubyObject the object to be converted obj) Check whether the given object is an Integer or can be converted to an Integer using #to_int.
public static IRubyObject	Returns: a Rational based on the object, or nil if it could not be converted checkToRational(ThreadContext the current thread context context, IRubyObject the object to convert obj) Convert the given argument to a Rational, or return nil if it cannot be converted.
public static IRubyObject	Returns: the String value or nil if the object or conversion is not a String. checkToString(ThreadContext the current thread context context, IRubyObject the object to be converted obj) Check whether the given object is a String or can be converted to a String using #to_str.
public static byte	toByte(ThreadContext context, IRubyObject arg)
public static double	Returns: the value toDouble(ThreadContext the current thread context context, IRubyObject the Object to convert arg) Safely convert a Ruby Numeric into a java double value.
public static int	Returns: the int value toInt(ThreadContext the current thread context context, IRubyObject the RubyNumeric to convert arg) Safely convert a Ruby Numeric into a java long value.
public static long	toInt(ThreadContext context, RubyFloat value)
public static int	toInt(ThreadContext context, RubyFixnum arg)
public static RubyInteger	Returns: the int value toInteger(ThreadContext the current thread context context, IRubyObject the RubyNumeric to convert arg) Safely convert a Ruby Numeric into a java long value.
private static long	toIntOther(ThreadContext context, IRubyObject arg)
public static long	Returns: the value toLong(ThreadContext the current thread context context, IRubyObject the RubyNumeric to convert arg) Safely convert a Ruby Numeric into a java long value.
public static long	toLong(ThreadContext context, RubyBignum value)
public static long	toLong(ThreadContext context, RubyFloat value)
private static long	toLongOther(ThreadContext context, IRubyObject arg)
public static RubySymbol	Returns: the new RubySymbol toSymbol(ThreadContext the current thread context context, IRubyObject the object to convert to a symbol arg) Convert the given object to a Symbol, possibly calling to_str in the process.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Convert	back to summary
public Convert()

Method Detail

asBoolean	back to summary
public static RubyBoolean asBoolean(ThreadContext context, boolean value) Create a Ruby Boolean from a java boolean. Parameters context:ThreadContext the current thread context value:boolean the boolean value Returns:RubyBoolean the Ruby Boolean

asBoolean

back to summary

public static RubyBoolean asBoolean(ThreadContext context, boolean value)

Create a Ruby Boolean from a java boolean.

Parameters

context:ThreadContext: the current thread context
value:boolean: the boolean value

Returns:RubyBoolean

the Ruby Boolean

asFixnum	back to summary
public static RubyFixnum asFixnum(ThreadContext context, long value) Create a Ruby Fixnum from a java long. Parameters context:ThreadContext the current thread context value:long the long value Returns:RubyFixnum the Ruby Fixnum

asFixnum

back to summary

public static RubyFixnum asFixnum(ThreadContext context, long value)

Create a Ruby Fixnum from a java long.

Parameters

context:ThreadContext: the current thread context
value:long: the long value

Returns:RubyFixnum

the Ruby Fixnum

asFixnum	back to summary
public static RubyFixnum asFixnum(ThreadContext context, int value) Create a Ruby Fixnum from a java int. Parameters context:ThreadContext the current thread context value:int the int value Returns:RubyFixnum the Ruby Fixnum

asFixnum

back to summary

public static RubyFixnum asFixnum(ThreadContext context, int value)

Create a Ruby Fixnum from a java int.

Parameters

context:ThreadContext: the current thread context
value:int: the int value

Returns:RubyFixnum

the Ruby Fixnum

asFloat	back to summary
public static RubyFloat asFloat(ThreadContext context, double value) Create a Ruby Float from a java double. Parameters context:ThreadContext the current thread context value:double the double value Returns:RubyFloat the Ruby Float

asFloat

back to summary

public static RubyFloat asFloat(ThreadContext context, double value)

Create a Ruby Float from a java double.

Parameters

context:ThreadContext: the current thread context
value:double: the double value

Returns:RubyFloat

the Ruby Float

asFloat	back to summary
public static RubyFloat asFloat(ThreadContext context, long value) Create a Ruby Float from a java long. Parameters context:ThreadContext the current thread context value:long the long value Returns:RubyFloat the Ruby Float

asFloat

back to summary

public static RubyFloat asFloat(ThreadContext context, long value)

Create a Ruby Float from a java long.

Parameters

context:ThreadContext: the current thread context
value:long: the long value

Returns:RubyFloat

the Ruby Float

asInteger	back to summary
public static RubyInteger asInteger(ThreadContext context, double value) Create some type of Ruby Integer from a java double Parameters context:ThreadContext the current thread context value:double the double value Returns:RubyInteger the result

asInteger

back to summary

public static RubyInteger asInteger(ThreadContext context, double value)

Create some type of Ruby Integer from a java double

Parameters

context:ThreadContext: the current thread context
value:double: the double value

Returns:RubyInteger

the result

asSymbol	back to summary
public static RubySymbol asSymbol(ThreadContext context, String string) Creates a new RubySymbol from the provided java String. Parameters context:ThreadContext the current thread context string:String the contents to become a symbol Returns:RubySymbol the new RubyString

asSymbol

back to summary

public static RubySymbol asSymbol(ThreadContext context, String string)

Creates a new RubySymbol from the provided java String.

Parameters

context:ThreadContext: the current thread context
string:String: the contents to become a symbol

Returns:RubySymbol

the new RubyString

asSymbol	back to summary
public static RubySymbol asSymbol(ThreadContext context, ByteList bytelist) Creates a new RubySymbol from the provided java String. Parameters context:ThreadContext the current thread context bytelist:ByteList the contents to become a symbol Returns:RubySymbol the new RubyString

asSymbol

back to summary

public static RubySymbol asSymbol(ThreadContext context, ByteList bytelist)

Creates a new RubySymbol from the provided java String.

Parameters

context:ThreadContext: the current thread context
bytelist:ByteList: the contents to become a symbol

Returns:RubySymbol

the new RubyString

asSymbol	back to summary
public static RubySymbol asSymbol(ThreadContext context, RubyString string) Creates a new RubySymbol from the provided java String. Parameters context:ThreadContext the current thread context string:RubyString the contents to become a symbol Returns:RubySymbol the new RubySymbol

asSymbol

back to summary

public static RubySymbol asSymbol(ThreadContext context, RubyString string)

Creates a new RubySymbol from the provided java String.

Parameters

context:ThreadContext: the current thread context
string:RubyString: the contents to become a symbol

Returns:RubySymbol

the new RubySymbol

castAsArray	back to summary
public static RubyArray<T extends IRubyObject> castAsArray(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyArray with most basic typeError thrown if the value is not a RubyArray. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyArray<T extends IRubyObject> the value as a RubyArray

castAsArray

back to summary

public static RubyArray<T extends IRubyObject> castAsArray(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyArray with most basic typeError thrown if the value is not a RubyArray.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyArray<T extends IRubyObject>

the value as a RubyArray

castAsArray	back to summary
public static RubyArray<T extends IRubyObject> castAsArray(ThreadContext context, IRubyObject newValue, String message) Cast the given value to a RubyArray with most basic typeError thrown if the value is not a RubyArray. Note if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast message:String the message to include in the type error Returns:RubyArray<T extends IRubyObject> the value as a RubyArray

castAsArray

back to summary

public static RubyArray<T extends IRubyObject> castAsArray(ThreadContext context, IRubyObject newValue, String message)

Cast the given value to a RubyArray with most basic typeError thrown if the value is not a RubyArray.

Note

if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast
message:String: the message to include in the type error

Returns:RubyArray<T extends IRubyObject>

the value as a RubyArray

castAsBignum	back to summary
public static RubyBignum castAsBignum(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyBignum with most basic typeError thrown if the value is not a RubyBignum. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyBignum the value as a RubyBignum

castAsBignum

back to summary

public static RubyBignum castAsBignum(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyBignum with most basic typeError thrown if the value is not a RubyBignum.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyBignum

the value as a RubyBignum

castAsClass	back to summary
public static RubyClass castAsClass(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyClass with most basic typeError thrown if the value is not a RubyClass. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyClass the value as a RubyClass

castAsClass

back to summary

public static RubyClass castAsClass(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyClass with most basic typeError thrown if the value is not a RubyClass.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyClass

the value as a RubyClass

castAsFile	back to summary
public static RubyFile castAsFile(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyFile with most basic typeError thrown if the value is not a RubyFile. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyFile the value as a RubyFile

castAsFile

back to summary

public static RubyFile castAsFile(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyFile with most basic typeError thrown if the value is not a RubyFile.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyFile

the value as a RubyFile

castAsFixnum	back to summary
public static RubyFixnum castAsFixnum(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyFixnum with most basic typeError thrown if the value is not a RubyFixnum. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyFixnum the value as a RubyFixnum

castAsFixnum

back to summary

public static RubyFixnum castAsFixnum(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyFixnum with most basic typeError thrown if the value is not a RubyFixnum.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyFixnum

the value as a RubyFixnum

castAsFixnum	back to summary
public static RubyFixnum castAsFixnum(ThreadContext context, IRubyObject newValue, String message) Cast the given value to a RubyFixnum with most basic typeError thrown if the value is not a RubyFixnum. Note if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast message:String the message to include in the type error Returns:RubyFixnum the value as a RubyFixnum

castAsFixnum

back to summary

public static RubyFixnum castAsFixnum(ThreadContext context, IRubyObject newValue, String message)

Cast the given value to a RubyFixnum with most basic typeError thrown if the value is not a RubyFixnum.

Note

if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast
message:String: the message to include in the type error

Returns:RubyFixnum

the value as a RubyFixnum

castAsHash	back to summary
public static RubyHash castAsHash(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyHash with most basic typeError thrown if the value is not a RubyHash. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyHash the value as a RubyHash

castAsHash

back to summary

public static RubyHash castAsHash(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyHash with most basic typeError thrown if the value is not a RubyHash.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyHash

the value as a RubyHash

castAsHash	back to summary
public static RubyHash castAsHash(ThreadContext context, IRubyObject newValue, String message) Cast the given value to a RubyHash with most basic typeError thrown if the value is not a RubyHash. Note if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast message:String the message to include in the type error Returns:RubyHash the value as a RubyHash

castAsHash

back to summary

public static RubyHash castAsHash(ThreadContext context, IRubyObject newValue, String message)

Cast the given value to a RubyHash with most basic typeError thrown if the value is not a RubyHash.

Note

if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast
message:String: the message to include in the type error

Returns:RubyHash

the value as a RubyHash

castAsInteger	back to summary
public static RubyInteger castAsInteger(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyInteger with most basic typeError thrown if the value is not a RubyInteger. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyInteger the value as a RubyInteger

castAsInteger

back to summary

public static RubyInteger castAsInteger(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyInteger with most basic typeError thrown if the value is not a RubyInteger.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyInteger

the value as a RubyInteger

castAsInteger	back to summary
public static RubyInteger castAsInteger(ThreadContext context, IRubyObject newValue, String message) Cast the given value to a RubyInteger with most basic typeError thrown if the value is not a RubyInteger. Note if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast message:String the message to include in the type error Returns:RubyInteger the value as a RubyInteger

castAsInteger

back to summary

public static RubyInteger castAsInteger(ThreadContext context, IRubyObject newValue, String message)

Cast the given value to a RubyInteger with most basic typeError thrown if the value is not a RubyInteger.

Note

if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast
message:String: the message to include in the type error

Returns:RubyInteger

the value as a RubyInteger

castAsModule	back to summary
public static RubyModule castAsModule(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyModule with most basic typeError thrown if the value is not a RubyModule. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyModule the value as a RubyModule

castAsModule

back to summary

public static RubyModule castAsModule(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyModule with most basic typeError thrown if the value is not a RubyModule.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyModule

the value as a RubyModule

castAsModule	back to summary
public static RubyModule castAsModule(ThreadContext context, IRubyObject newValue, String message) Cast the given value to a RubyModule with most basic typeError thrown if the value is not a RubyModule. Note if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast message:String the message to include in the type error Returns:RubyModule the value as a RubyModule

castAsModule

back to summary

public static RubyModule castAsModule(ThreadContext context, IRubyObject newValue, String message)

Cast the given value to a RubyModule with most basic typeError thrown if the value is not a RubyModule.

Note

if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast
message:String: the message to include in the type error

Returns:RubyModule

the value as a RubyModule

castAsNumeric	back to summary
public static RubyNumeric castAsNumeric(ThreadContext context, IRubyObject newValue, String message) Cast the given value to a RubyNumeric with most basic typeError thrown if the value is not a RubyNumeric. Note if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast message:String the message to include in the type error Returns:RubyNumeric the value as a RubyNumeric

castAsNumeric

back to summary

public static RubyNumeric castAsNumeric(ThreadContext context, IRubyObject newValue, String message)

Cast the given value to a RubyNumeric with most basic typeError thrown if the value is not a RubyNumeric.

Note

if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast
message:String: the message to include in the type error

Returns:RubyNumeric

the value as a RubyNumeric

castAsProc	back to summary
public static RubyProc castAsProc(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyProc with most basic typeError thrown if the value is not a RubyProc. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyProc the value as a RubyProc

castAsProc

back to summary

public static RubyProc castAsProc(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyProc with most basic typeError thrown if the value is not a RubyProc.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyProc

the value as a RubyProc

castAsProc	back to summary
public static RubyProc castAsProc(ThreadContext context, IRubyObject newValue, String message) Cast the given value to a RubyProc with most basic typeError thrown if the value is not a RubyProc. Note if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast message:String the message to include in the type error Returns:RubyProc the value as a RubyProc

castAsProc

back to summary

public static RubyProc castAsProc(ThreadContext context, IRubyObject newValue, String message)

Cast the given value to a RubyProc with most basic typeError thrown if the value is not a RubyProc.

Note

if message is constructed you will pay that contruction cost. Manually cast to avoid that overhead in that case.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast
message:String: the message to include in the type error

Returns:RubyProc

the value as a RubyProc

castAsRange	back to summary
public static RubyRange castAsRange(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyRange with most basic typeError thrown if the value is not a RubyRange. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyRange the value as a RubyRange

castAsRange

back to summary

public static RubyRange castAsRange(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyRange with most basic typeError thrown if the value is not a RubyRange.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyRange

the value as a RubyRange

castAsString	back to summary
public static RubyString castAsString(ThreadContext context, IRubyObject newValue) Cast the given value to a RubyString with most basic typeError thrown if the value is not a RubyString. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubyString the value as a RubyString

castAsString

back to summary

public static RubyString castAsString(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubyString with most basic typeError thrown if the value is not a RubyString.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubyString

the value as a RubyString

castAsSymbol	back to summary
public static RubySymbol castAsSymbol(ThreadContext context, IRubyObject newValue) Cast the given value to a RubySymbol with most basic typeError thrown if the value is not a RubySymbol. Parameters context:ThreadContext the current thread context newValue:IRubyObject the value to cast Returns:RubySymbol the value as a RubySymbol

castAsSymbol

back to summary

public static RubySymbol castAsSymbol(ThreadContext context, IRubyObject newValue)

Cast the given value to a RubySymbol with most basic typeError thrown if the value is not a RubySymbol.

Parameters

context:ThreadContext: the current thread context
newValue:IRubyObject: the value to cast

Returns:RubySymbol

the value as a RubySymbol

checkInt	back to summary
public static int checkInt(ThreadContext context, long num) Check to make sure the long num given will fit into an int. Parameters context:ThreadContext the current thread context num:long the long to check Returns:int the int value

checkInt

back to summary

public static int checkInt(ThreadContext context, long num)

Check to make sure the long num given will fit into an int.

Parameters

context:ThreadContext: the current thread context
num:long: the long to check

Returns:int

the int value

checkToInteger	back to summary
public static IRubyObject checkToInteger(ThreadContext context, IRubyObject obj) Check whether the given object is an Integer or can be converted to an Integer using #to_int. Parameters context:ThreadContext the current thread context obj:IRubyObject the object to be converted Returns:IRubyObject the integer value or nil if the object or conversion is not an Integer.

checkToInteger

back to summary

public static IRubyObject checkToInteger(ThreadContext context, IRubyObject obj)

Check whether the given object is an Integer or can be converted to an Integer using #to_int.

Parameters

context:ThreadContext: the current thread context
obj:IRubyObject: the object to be converted

Returns:IRubyObject

the integer value or nil if the object or conversion is not an Integer.

checkToRational	back to summary
public static IRubyObject checkToRational(ThreadContext context, IRubyObject obj) Convert the given argument to a Rational, or return nil if it cannot be converted. Parameters context:ThreadContext the current thread context obj:IRubyObject the object to convert Returns:IRubyObject a Rational based on the object, or nil if it could not be converted

checkToRational

back to summary

public static IRubyObject checkToRational(ThreadContext context, IRubyObject obj)

Convert the given argument to a Rational, or return nil if it cannot be converted.

Parameters

context:ThreadContext: the current thread context
obj:IRubyObject: the object to convert

Returns:IRubyObject

a Rational based on the object, or nil if it could not be converted

checkToString	back to summary
public static IRubyObject checkToString(ThreadContext context, IRubyObject obj) Check whether the given object is a String or can be converted to a String using #to_str. Parameters context:ThreadContext the current thread context obj:IRubyObject the object to be converted Returns:IRubyObject the String value or nil if the object or conversion is not a String.

checkToString

back to summary

public static IRubyObject checkToString(ThreadContext context, IRubyObject obj)

Check whether the given object is a String or can be converted to a String using #to_str.

Parameters

context:ThreadContext: the current thread context
obj:IRubyObject: the object to be converted

Returns:IRubyObject

the String value or nil if the object or conversion is not a String.

toByte	back to summary
public static byte toByte(ThreadContext context, IRubyObject arg)

toDouble	back to summary
public static double toDouble(ThreadContext context, IRubyObject arg) Safely convert a Ruby Numeric into a java double value. Raising if the value will not fit. Parameters context:ThreadContext the current thread context arg:IRubyObject the Object to convert Returns:double the value

toDouble

back to summary

public static double toDouble(ThreadContext context, IRubyObject arg)

Safely convert a Ruby Numeric into a java double value. Raising if the value will not fit.

Parameters

context:ThreadContext: the current thread context
arg:IRubyObject: the Object to convert

Returns:double

the value

toInt	back to summary
public static int toInt(ThreadContext context, IRubyObject arg) Safely convert a Ruby Numeric into a java long value. Raising if the value will not fit. Parameters context:ThreadContext the current thread context arg:IRubyObject the RubyNumeric to convert Returns:int the int value

toInt

back to summary

public static int toInt(ThreadContext context, IRubyObject arg)

Safely convert a Ruby Numeric into a java long value. Raising if the value will not fit.

Parameters

context:ThreadContext: the current thread context
arg:IRubyObject: the RubyNumeric to convert

Returns:int

the int value

toInt	back to summary
public static long toInt(ThreadContext context, RubyFloat value)

toInt	back to summary
public static int toInt(ThreadContext context, RubyFixnum arg)

toInteger	back to summary
public static RubyInteger toInteger(ThreadContext context, IRubyObject arg) Safely convert a Ruby Numeric into a java long value. Raising if the value will not fit. Parameters context:ThreadContext the current thread context arg:IRubyObject the RubyNumeric to convert Returns:RubyInteger the int value

toInteger

back to summary

public static RubyInteger toInteger(ThreadContext context, IRubyObject arg)

Safely convert a Ruby Numeric into a java long value. Raising if the value will not fit.

Parameters

context:ThreadContext: the current thread context
arg:IRubyObject: the RubyNumeric to convert

Returns:RubyInteger

the int value

toIntOther	back to summary
private static long toIntOther(ThreadContext context, IRubyObject arg)

toLong	back to summary
public static long toLong(ThreadContext context, IRubyObject arg) Safely convert a Ruby Numeric into a java long value. Raising if the value will not fit. Parameters context:ThreadContext the current thread context arg:IRubyObject the RubyNumeric to convert Returns:long the value

toLong

back to summary

public static long toLong(ThreadContext context, IRubyObject arg)

Safely convert a Ruby Numeric into a java long value. Raising if the value will not fit.

Parameters

context:ThreadContext: the current thread context
arg:IRubyObject: the RubyNumeric to convert

Returns:long

the value

toLong	back to summary
public static long toLong(ThreadContext context, RubyBignum value)

toLong	back to summary
public static long toLong(ThreadContext context, RubyFloat value)

toLongOther	back to summary
private static long toLongOther(ThreadContext context, IRubyObject arg)

toSymbol	back to summary
public static RubySymbol toSymbol(ThreadContext context, IRubyObject arg) Convert the given object to a Symbol, possibly calling to_str in the process. MRI: rb_to_symbol Parameters context:ThreadContext the current thread context arg:IRubyObject the object to convert to a symbol Returns:RubySymbol the new RubySymbol

toSymbol

back to summary

public static RubySymbol toSymbol(ThreadContext context, IRubyObject arg)

Convert the given object to a Symbol, possibly calling to_str in the process. MRI: rb_to_symbol

Parameters

context:ThreadContext: the current thread context
arg:IRubyObject: the object to convert to a symbol

Returns:RubySymbol

the new RubySymbol

public Class Convert

Constructor Summary

Method Summary

Constructor Detail

Method Detail