org.jruby

Class RubyMatchData

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyMatchData

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class RubyMatchData
extends RubyObject

Author:

olabini

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields inherited from class org.jruby.RubyObject

FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Constructor and Description
RubyMatchData(Ruby runtime)
RubyMatchData(Ruby runtime, RubyClass metaClass)

Method Summary

Methods

Modifier and Type	Method and Description
int	backrefNumber(IRubyObject obj)
static int	backrefNumber(Ruby runtime, org.joni.Regex pattern, org.joni.Region regs, IRubyObject obj)
int	begin(int i) Get the begin offset of the given region, or -1 if the region does not exist.
IRubyObject	begin(ThreadContext context, IRubyObject index) MRI: match_begin
IRubyObject	captures(ThreadContext context) match_captures
void	copySpecialInstanceVariables(IRubyObject clone) Lots of MRI objects keep their state in non-lookupable ivars (e:g.
static RubyClass	createMatchDataClass(Ruby runtime)
int	end(int i) Get the end offset of the given region, or -1 if the region does not exist.
IRubyObject	end(ThreadContext context, IRubyObject index) match_end
IRubyObject	eql_p(IRubyObject obj) rb_obj_equal Just like "==" and "equal?", "eql?" will use identity equality for Object.
boolean	equals(Object other) This method is just a wrapper around the Ruby "==" method, provided so that RubyObjects can be used as keys in the Java HashMap object underlying RubyHash.
IRubyObject[]	getNamedBackrefValues(Ruby runtime)
int	getNameToBackrefNumber(String name)
ClassIndex	getNativeClassIndex() This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
IRubyObject	group(int n)
IRubyObject	group(long n)
RubyFixnum	hash() rb_obj_id Will return the hash code of this object.
IRubyObject	initialize_copy(IRubyObject original) rb_obj_init_copy Initializes this object as a copy of the original, that is the parameter to this object.
IRubyObject	inspect() rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
IRubyObject	names(ThreadContext context, Block block)
int	numRegs() Fetch the number of regions in this match.
IRubyObject	offset(ThreadContext context, IRubyObject index) match_offset
IRubyObject	offset19(ThreadContext context, IRubyObject index)
IRubyObject	op_aref(IRubyObject idx) match_aref
IRubyObject	op_aref(IRubyObject idx, IRubyObject rest) match_aref
IRubyObject	op_aref19(IRubyObject idx) match_aref
IRubyObject	op_aref19(IRubyObject idx, IRubyObject rest) match_aref
IRubyObject	post_match(ThreadContext context) match_post_match
IRubyObject	pre_match(ThreadContext context) match_pre_match
IRubyObject	regexp(ThreadContext context, Block block)
IRubyObject	size(ThreadContext context) match_size
IRubyObject	string() match_string
RubyArray	to_a() match_to_a
IRubyObject	to_s() match_to_s
void	use()
boolean	used()
IRubyObject	values_at(IRubyObject[] args)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, eqlInternal, equalInternal, hashCode, initialize, initialize, inspect, op_eqq, puts, specificEval, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, display, dup, ensureInstanceVariablesSettable, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize19, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_equal, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, toJava, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RubyMatchData

public RubyMatchData(Ruby runtime)

RubyMatchData

public RubyMatchData(Ruby runtime,
             RubyClass metaClass)

Method Detail

createMatchDataClass

public static RubyClass createMatchDataClass(Ruby runtime)

copySpecialInstanceVariables

public void copySpecialInstanceVariables(IRubyObject clone)

Description copied from class: RubyBasicObject

Lots of MRI objects keep their state in non-lookupable ivars (e:g. Range, Struct, etc). This method is responsible for dupping our java field equivalents

Specified by:

copySpecialInstanceVariables in interface IRubyObject

Overrides:

copySpecialInstanceVariables in class RubyBasicObject

getNativeClassIndex

public ClassIndex getNativeClassIndex()

Description copied from class: RubyObject

This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are. Will generally return a value from org.jruby.runtime.ClassIndex

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyObject

See Also:

ClassIndex

use

public final void use()

used

public final boolean used()

group

public IRubyObject group(long n)

group

public IRubyObject group(int n)

getNameToBackrefNumber

public int getNameToBackrefNumber(String name)

getNamedBackrefValues

public IRubyObject[] getNamedBackrefValues(Ruby runtime)

inspect

public IRubyObject inspect()

Description copied from class: RubyBasicObject

rb_obj_inspect call-seq: obj.inspect => string 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"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

Returns:

String

regexp

public IRubyObject regexp(ThreadContext context,
                 Block block)

names

public IRubyObject names(ThreadContext context,
                Block block)

to_a

public RubyArray to_a()

match_to_a

Overrides:

to_a in class RubyBasicObject

values_at

public IRubyObject values_at(IRubyObject[] args)

captures

public IRubyObject captures(ThreadContext context)

match_captures

backrefNumber

public final int backrefNumber(IRubyObject obj)

backrefNumber

public static int backrefNumber(Ruby runtime,
                org.joni.Regex pattern,
                org.joni.Region regs,
                IRubyObject obj)

op_aref

public IRubyObject op_aref(IRubyObject idx)

match_aref

op_aref

public IRubyObject op_aref(IRubyObject idx,
                  IRubyObject rest)

match_aref

op_aref19

public IRubyObject op_aref19(IRubyObject idx)

match_aref

op_aref19

public IRubyObject op_aref19(IRubyObject idx,
                    IRubyObject rest)

match_aref

size

public IRubyObject size(ThreadContext context)

match_size

begin

public IRubyObject begin(ThreadContext context,
                IRubyObject index)

MRI: match_begin

end

public IRubyObject end(ThreadContext context,
              IRubyObject index)

match_end

offset

public IRubyObject offset(ThreadContext context,
                 IRubyObject index)

match_offset

offset19

public IRubyObject offset19(ThreadContext context,
                   IRubyObject index)

pre_match

public IRubyObject pre_match(ThreadContext context)

match_pre_match

post_match

public IRubyObject post_match(ThreadContext context)

match_post_match

to_s

public IRubyObject to_s()

match_to_s

Overrides:

to_s in class RubyBasicObject

string

public IRubyObject string()

match_string

initialize_copy

public IRubyObject initialize_copy(IRubyObject original)

Description copied from class: RubyBasicObject

rb_obj_init_copy Initializes this object as a copy of the original, that is the parameter to this object. Will make sure that the argument actually has the same real class as this object. It shouldn't be possible to initialize an object with something totally different.

Overrides:

initialize_copy in class RubyBasicObject

equals

public boolean equals(Object other)

Description copied from class: RubyObject

This method is just a wrapper around the Ruby "==" method, provided so that RubyObjects can be used as keys in the Java HashMap object underlying RubyHash.

Overrides:

equals in class RubyObject

eql_p

public IRubyObject eql_p(IRubyObject obj)

Description copied from class: RubyBasicObject

rb_obj_equal Just like "==" and "equal?", "eql?" will use identity equality for Object.

Overrides:

eql_p in class RubyBasicObject

hash

public RubyFixnum hash()

Description copied from class: RubyBasicObject

rb_obj_id Will return the hash code of this object. In comparison to MRI, this method will use the Java identity hash code instead of using rb_obj_id, since the usage of id in JRuby will incur the cost of some. ObjectSpace maintenance.

Overrides:

hash in class RubyBasicObject

begin

public int begin(int i)

Get the begin offset of the given region, or -1 if the region does not exist.

Parameters:

i - the region for which to fetch the begin offset

Returns:

the begin offset for the region

end

public int end(int i)

Get the end offset of the given region, or -1 if the region does not exist.

Parameters:

i - the region for which to fetch the end offset

Returns:

the end offset for the region

numRegs

public int numRegs()

Fetch the number of regions in this match.

Returns:

the number of regions in this match