Modifier and Type	Class and Description
public static class	Type.Array
public static class	Type.Builtin

Modifier and Type	Field and Description
protected final int	alignment Minimum alignment of this type in bytes
private static final Locale	LOCALE
protected final NativeType	nativeType
protected final int	size Size of this type in bytes

Access	Constructor and Description
protected	Type(Ruby runtime, RubyClass klass, NativeType type, int size, int alignment) Initializes a new `Type` instance.
protected	Type(Ruby runtime, RubyClass klass, NativeType type) Initializes a new `Type` instance.

Method Summary

Modifier and Type	Method and Description
public IRubyObject	Returns: The native alignment of this Type. alignment(ThreadContext The Ruby thread context. context) Gets the native alignment of this `Type` in bytes
public static RubyClass	createTypeClass(ThreadContext context, RubyModule FFI, RubyClass Object)
private static final void	defineBuiltinType(ThreadContext context, RubyClass builtinClass, NativeType nativeType, String... names)
public final int	Returns: The native alignment of this Type. getNativeAlignment() Gets the native alignment of this `Type` in bytes
pack-priv static final int	getNativeAlignment(NativeType type)
public final int	Returns: The native size of this Type. getNativeSize() Gets the native size of this `Type` in bytes
pack-priv static final int	getNativeSize(NativeType type)
public final NativeType	Returns: The native type of this Type. getNativeType() Gets the native type of this `Type` when passed as a parameter
public static final RubyClass	getTypeClass(Ruby runtime)
private static final boolean	isPrimitive(NativeType type)
public IRubyObject	Returns: The native size of this Type. size(ThreadContext The Ruby thread context. context) Gets the native size of this `Type` in bytes

alignment	back to summary
protected final int alignment Minimum alignment of this type in bytes

LOCALE	back to summary
private static final Locale LOCALE

nativeType	back to summary
protected final NativeType nativeType

size	back to summary
protected final int size Size of this type in bytes

Type	back to summary
protected Type(Ruby runtime, RubyClass klass, NativeType type, int size, int alignment) Initializes a new `Type` instance.

Type	back to summary
protected Type(Ruby runtime, RubyClass klass, NativeType type) Initializes a new `Type` instance.

Method Detail

alignment back to summary

alignment	back to summary
public IRubyObject alignment(ThreadContext context) Gets the native alignment of this `Type` in bytes Parameters context:ThreadContext The Ruby thread context. Returns:IRubyObject The native alignment of this Type. Annotations @JRubyMethod name:alignment

public IRubyObject alignment(ThreadContext context)

Gets the native alignment of this Type in bytes

Parameters

context:ThreadContext: The Ruby thread context.

Returns:IRubyObject

The native alignment of this Type.

Annotations

@JRubyMethod
name:alignment

createTypeClass	back to summary
public static RubyClass createTypeClass(ThreadContext context, RubyModule FFI, RubyClass Object)

defineBuiltinType	back to summary
private static final void defineBuiltinType(ThreadContext context, RubyClass builtinClass, NativeType nativeType, String... names)

getNativeAlignment back to summary

getNativeAlignment	back to summary
public final int getNativeAlignment() Gets the native alignment of this `Type` in bytes Returns:int The native alignment of this Type.

public final int getNativeAlignment()

Gets the native alignment of this Type in bytes

Returns:int: The native alignment of this Type.

getNativeAlignment	back to summary
pack-priv static final int getNativeAlignment(NativeType type)

getNativeSize back to summary

getNativeSize	back to summary
public final int getNativeSize() Gets the native size of this `Type` in bytes Returns:int The native size of this Type.

public final int getNativeSize()

Gets the native size of this Type in bytes

Returns:int: The native size of this Type.

getNativeSize	back to summary
pack-priv static final int getNativeSize(NativeType type)

getNativeType back to summary

getNativeType	back to summary
public final NativeType getNativeType() Gets the native type of this `Type` when passed as a parameter Returns:NativeType The native type of this Type.

public final NativeType getNativeType()

Gets the native type of this Type when passed as a parameter

Returns:NativeType: The native type of this Type.

getTypeClass	back to summary
public static final RubyClass getTypeClass(Ruby runtime)

isPrimitive	back to summary
private static final boolean isPrimitive(NativeType type)

size back to summary

size	back to summary
public IRubyObject size(ThreadContext context) Gets the native size of this `Type` in bytes Parameters context:ThreadContext The Ruby thread context. Returns:IRubyObject The native size of this Type. Annotations @JRubyMethod name:size

public IRubyObject size(ThreadContext context)

Gets the native size of this Type in bytes

Parameters

context:ThreadContext: The Ruby thread context.

Returns:IRubyObject

The native size of this Type.

Annotations

@JRubyMethod
name:size

org.jruby.ext.ffi back to summary

public final Class Type.Array

Class Inheritance

extends Type

Annotations

@JRubyClass
name:FFI::Type::Array
parent:FFI::Type

Field Summary

Modifier and Type	Field and Description
private final Type	componentType
private final int	length

Inherited from org.jruby.ext.ffi.Type:: alignment nativeType size

Constructor Summary

Access	Constructor and Description
public	Array(Ruby runtime, RubyClass klass, Type componentType, int length) Initializes a new `Type.Array` instance.
public	Array(Ruby runtime, Type componentType, int length) Initializes a new `Type.Array` instance.

Method Summary

Modifier and Type	Method and Description
public final IRubyObject	elem_type(ThreadContext context)
public final Type	getComponentType()
public final int	length()
public final IRubyObject	length(ThreadContext context)
public static final IRubyObject	newInstance(ThreadContext context, IRubyObject klass, IRubyObject componentType, IRubyObject length)

Inherited from org.jruby.ext.ffi.Type:: alignment createTypeClass getNativeAlignment getNativeAlignment getNativeSize getNativeSize getNativeType getTypeClass size

Field Detail

componentType	back to summary
private final Type componentType

length	back to summary
private final int length

Constructor Detail

Array	back to summary
public Array(Ruby runtime, RubyClass klass, Type componentType, int length) Initializes a new `Type.Array` instance.

Array	back to summary
public Array(Ruby runtime, Type componentType, int length) Initializes a new `Type.Array` instance.

Method Detail

elem_type	back to summary
public final IRubyObject elem_type(ThreadContext context) Annotations @JRubyMethod

getComponentType	back to summary
public final Type getComponentType()

length	back to summary
public final int length()

length	back to summary
public final IRubyObject length(ThreadContext context) Annotations @JRubyMethod

newInstance	back to summary
public static final IRubyObject newInstance(ThreadContext context, IRubyObject klass, IRubyObject componentType, IRubyObject length) Annotations @JRubyMethod name:new required:2 meta:true

org.jruby.ext.ffi back to summary

public final Class Type.Builtin

Class Inheritance

extends Type

Annotations

@JRubyClass
name:FFI::Type::Builtin
parent:FFI::Type

Field Summary

Modifier and Type	Field and Description
private final RubySymbol	sym

Inherited from org.jruby.ext.ffi.Type:: alignment nativeType size

Constructor Summary

Access	Constructor and Description
private	Builtin(ThreadContext context, RubyClass klass, NativeType nativeType, String symName) Initializes a new `BuiltinType` instance.

Method Summary

Modifier and Type	Method and Description
public IRubyObject	eql_p(ThreadContext context, IRubyObject obj) Overrides org.jruby.RubyBasicObject.eql_p.
public IRubyObject	equal_p(ThreadContext the thread context context, IRubyObject to compare with obj) Overrides org.jruby.RubyBasicObject.equal_p. rb_obj_equal Will use Java identity equality.
public boolean	equals(Object object to compare obj) Overrides org.jruby.RubyObject.equals. This override does not do a "checked" dispatch.
public int	hashCode() Overrides org.jruby.RubyObject.hashCode. This override does not do "checked" dispatch since Object usually has #hash defined.
public final IRubyObject	inspect(ThreadContext context) Overrides org.jruby.RubyBasicObject.inspect. Overrides default org.jruby.runtime.builtin.IRubyObject.inspect. Returns a string containing a human-readable representation of obj.
public IRubyObject	op_equal(ThreadContext context, IRubyObject obj) Overrides org.jruby.RubyBasicObject.op_equal. Implements org.jruby.runtime.builtin.IRubyObject.op_equal. rb_obj_equal Will by default use identity equality to compare objects.
public final IRubyObject	to_sym(ThreadContext context)
public final String	toString() Overrides org.jruby.RubyObject.toString. The default toString method is just a wrapper that calls the Ruby "to_s" method.

Inherited from org.jruby.ext.ffi.Type:: alignment createTypeClass getNativeAlignment getNativeAlignment getNativeSize getNativeSize getNativeType getTypeClass size

Field Detail

sym	back to summary
private final RubySymbol sym

Constructor Detail

Builtin	back to summary
private Builtin(ThreadContext context, RubyClass klass, NativeType nativeType, String symName) Initializes a new `BuiltinType` instance.

Method Detail

eql_p	back to summary
public IRubyObject eql_p(ThreadContext context, IRubyObject obj) Overrides org.jruby.RubyBasicObject.eql_p. Annotations @JRubyMethod name:eql?

eql_p

back to summary

public IRubyObject eql_p(ThreadContext context, IRubyObject obj)

Overrides org.jruby.RubyBasicObject.eql_p.

Annotations

@JRubyMethod
name:eql?

equal_p	back to summary
public IRubyObject equal_p(ThreadContext context, IRubyObject obj) Overrides org.jruby.RubyBasicObject.equal_p. Doc from org.jruby.RubyBasicObject.equal_p. rb_obj_equal Will use Java identity equality. Parameters context:ThreadContext the thread context obj:IRubyObject to compare with Returns:IRubyObject are they equal? Annotations @Override @JRubyMethod name:equal?

equal_p

back to summary

public IRubyObject equal_p(ThreadContext context, IRubyObject obj)

Overrides org.jruby.RubyBasicObject.equal_p.

Doc from org.jruby.RubyBasicObject.equal_p.

rb_obj_equal Will use Java identity equality.

Parameters

context:ThreadContext: the thread context
obj:IRubyObject: to compare with

Returns:IRubyObject

are they equal?

Annotations

@Override
@JRubyMethod
name:equal?

equals	back to summary
public boolean equals(Object obj) Overrides org.jruby.RubyObject.equals. Doc from org.jruby.RubyObject.equals. This override does not do a "checked" dispatch. Parameters obj:Object Doc from org.jruby.RubyBasicObject.equals. object to compare Returns:boolean Doc from org.jruby.RubyBasicObject.equals. true if equals Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides org.jruby.RubyObject.equals.

Doc from org.jruby.RubyObject.equals.

This override does not do a "checked" dispatch.

Parameters

obj:Object

Doc from org.jruby.RubyBasicObject.equals.

object to compare

Returns:boolean

Doc from org.jruby.RubyBasicObject.equals.

true if equals

Annotations

@Override

hashCode	back to summary
public int hashCode() Overrides org.jruby.RubyObject.hashCode. Doc from org.jruby.RubyObject.hashCode. This override does not do "checked" dispatch since Object usually has #hash defined. Returns:int the hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides org.jruby.RubyObject.hashCode.

Doc from org.jruby.RubyObject.hashCode.

This override does not do "checked" dispatch since Object usually has #hash defined.

Returns:int

the hash code

Annotations

@Override

inspect back to summary

inspect	back to summary
public final IRubyObject inspect(ThreadContext context) Overrides org.jruby.RubyBasicObject.inspect. Overrides default org.jruby.runtime.builtin.IRubyObject.inspect. Doc from org.jruby.RubyBasicObject.inspect. Returns a string containing a human-readable representation of obj. If not overridden, uses the `to_s` method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003" Annotations @JRubyMethod name:inspect

public final IRubyObject inspect(ThreadContext context)

Overrides org.jruby.RubyBasicObject.inspect.

Overrides default org.jruby.runtime.builtin.IRubyObject.inspect.

Doc from org.jruby.RubyBasicObject.inspect.

Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Annotations

@JRubyMethod
name:inspect

op_equal	back to summary
public IRubyObject op_equal(ThreadContext context, IRubyObject obj) Overrides org.jruby.RubyBasicObject.op_equal. Implements org.jruby.runtime.builtin.IRubyObject.op_equal. Doc from org.jruby.RubyBasicObject.op_equal. rb_obj_equal Will by default use identity equality to compare objects. This follows the Ruby semantics. The name of this method doesn't follow the convention because hierarchy problems Annotations @Override @JRubyMethod name:==

op_equal

back to summary

public IRubyObject op_equal(ThreadContext context, IRubyObject obj)

Overrides org.jruby.RubyBasicObject.op_equal.

Implements org.jruby.runtime.builtin.IRubyObject.op_equal.

Doc from org.jruby.RubyBasicObject.op_equal.

rb_obj_equal Will by default use identity equality to compare objects. This follows the Ruby semantics. The name of this method doesn't follow the convention because hierarchy problems

Annotations

@Override
@JRubyMethod
name:==

to_sym	back to summary
public final IRubyObject to_sym(ThreadContext context) Annotations @JRubyMethod

toString	back to summary
public final String toString() Overrides org.jruby.RubyObject.toString. Doc from org.jruby.RubyObject.toString. The default toString method is just a wrapper that calls the Ruby "to_s" method. Returns:String string representation Annotations @Override

toString

back to summary

public final String toString()

Overrides org.jruby.RubyObject.toString.

Doc from org.jruby.RubyObject.toString.

The default toString method is just a wrapper that calls the Ruby "to_s" method.

Returns:String

string representation

Annotations

@Override

public abstract Class Type

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Type.Array

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Type.Builtin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail