Package org.eclipse.epsilon.ecl.dom

Class MatchRule

java.lang.Object

org.eclipse.epsilon.common.module.AbstractModuleElement

org.eclipse.epsilon.eol.dom.AnnotatableModuleElement

org.eclipse.epsilon.erl.dom.NamedRule

org.eclipse.epsilon.erl.dom.ExtensibleNamedRule

org.eclipse.epsilon.ecl.dom.MatchRule

All Implemented Interfaces:

org.eclipse.epsilon.common.module.ModuleElement

public class MatchRule
extends ExtensibleNamedRule

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.epsilon.eol.dom.ExecutableBlock<Boolean>	compareBlock
protected org.eclipse.epsilon.eol.dom.ExecutableBlock<Void>	doBlock
protected org.eclipse.epsilon.eol.dom.ExecutableBlock<Boolean>	guardBlock
protected org.eclipse.epsilon.eol.dom.Parameter	leftParameter
protected org.eclipse.epsilon.eol.dom.Parameter	rightParameter

Fields inherited from class org.eclipse.epsilon.erl.dom.ExtensibleNamedRule

allSuperRules, isAbstract, isGreedy, isLazy, ofKindCache, ofTypeCache, superRules, superRulesIdentifiers

Fields inherited from class org.eclipse.epsilon.erl.dom.NamedRule

nameExpression

Fields inherited from class org.eclipse.epsilon.eol.dom.AnnotatableModuleElement

annotationBlock

Fields inherited from class org.eclipse.epsilon.common.module.AbstractModuleElement

children, comments, module, parent, region, uri

Constructor Summary

Constructors

Constructor	Description
MatchRule()

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(Object left, Object right, IEclContext context, boolean ofTypeOnly)
void	build(org.eclipse.epsilon.common.parse.AST cst, org.eclipse.epsilon.common.module.IModule module)
Collection<?>	getLeftInstances(IEclContext context, boolean ofTypeOnly)
Collection<?>	getRightInstances(IEclContext context, boolean ofTypeOnly)
org.eclipse.epsilon.common.parse.AST	getSuperRulesAst(org.eclipse.epsilon.common.parse.AST cst)
Match	match(Object left, Object right, IEclContext context, org.eclipse.epsilon.eol.types.EolMap<?,?> matchInfo, boolean forcedMatch)	Matches left against right
Match	matchPair(IEclContext context, boolean ofTypeOnly, Object leftInstance, Object rightInstance)
String	toString()

Methods inherited from class org.eclipse.epsilon.erl.dom.ExtensibleNamedRule

calculateSuperRules, calculateSuperRules, getAllInstances, getAllOfKind, getAllOfType, getAllSuperRules, getRuleByName, getSuperRules, isAbstract, isGreedy, isLazy

Methods inherited from class org.eclipse.epsilon.erl.dom.NamedRule

equals, getName, getNameAst, getNameExpression, hashCode, setNameExpression

Methods inherited from class org.eclipse.epsilon.eol.dom.AnnotatableModuleElement

getAnnotation, getAnnotationBlock, getAnnotations, getAnnotationsValues, getBooleanAnnotationValue, getBooleanAnnotationValue, getBooleanAnnotationValue, getBooleanAnnotationValue, hasAnnotation, setAnnotationBlock

Methods inherited from class org.eclipse.epsilon.common.module.AbstractModuleElement

getChildren, getComments, getDebugInfo, getFile, getModule, getParent, getRegion, getUri, setModule, setParent, setRegion, setUri

Methods inherited from class java.lang.Object

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

Field Detail

compareBlock

protected org.eclipse.epsilon.eol.dom.ExecutableBlock<Boolean> compareBlock

guardBlock

protected org.eclipse.epsilon.eol.dom.ExecutableBlock<Boolean> guardBlock

doBlock

protected org.eclipse.epsilon.eol.dom.ExecutableBlock<Void> doBlock

leftParameter

protected org.eclipse.epsilon.eol.dom.Parameter leftParameter

rightParameter

protected org.eclipse.epsilon.eol.dom.Parameter rightParameter

Constructor Detail

MatchRule

public MatchRule()

Method Detail

getSuperRulesAst

public org.eclipse.epsilon.common.parse.AST getSuperRulesAst(org.eclipse.epsilon.common.parse.AST cst)

Specified by:

getSuperRulesAst in class ExtensibleNamedRule

build

public void build(org.eclipse.epsilon.common.parse.AST cst,
                  org.eclipse.epsilon.common.module.IModule module)

Specified by:

build in interface org.eclipse.epsilon.common.module.ModuleElement

Overrides:

build in class ExtensibleNamedRule

appliesTo

public boolean appliesTo(Object left,
                         Object right,
                         IEclContext context,
                         boolean ofTypeOnly)
                  throws org.eclipse.epsilon.eol.exceptions.EolRuntimeException

Throws:

org.eclipse.epsilon.eol.exceptions.EolRuntimeException

getLeftInstances

public Collection<?> getLeftInstances(IEclContext context,
                                      boolean ofTypeOnly)
                               throws org.eclipse.epsilon.eol.exceptions.EolRuntimeException

Throws:

org.eclipse.epsilon.eol.exceptions.EolRuntimeException

getRightInstances

public Collection<?> getRightInstances(IEclContext context,
                                       boolean ofTypeOnly)
                                throws org.eclipse.epsilon.eol.exceptions.EolRuntimeException

Throws:

org.eclipse.epsilon.eol.exceptions.EolRuntimeException

matchPair

public Match matchPair(IEclContext context,
                       boolean ofTypeOnly,
                       Object leftInstance,
                       Object rightInstance)
                throws org.eclipse.epsilon.eol.exceptions.EolRuntimeException

Throws:

org.eclipse.epsilon.eol.exceptions.EolRuntimeException

match

public Match match(Object left,
                   Object right,
                   IEclContext context,
                   org.eclipse.epsilon.eol.types.EolMap<?,?> matchInfo,
                   boolean forcedMatch)
            throws org.eclipse.epsilon.eol.exceptions.EolRuntimeException

Matches left against right

Parameters:

left - The left object

right - The right object

context - The context in which the ECL program is running

asSuperRule - Shows if the rule is executed as a super-rule of another rule

forcedMatch - Whether to add the match to the trace (?)

Returns:

Throws:

org.eclipse.epsilon.eol.exceptions.EolRuntimeException

toString

public String toString()

Overrides:

toString in class NamedRule