Groovy Documentation
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

abs(Double) - Method in MathFunctions
Returns the absolute value of a value.
add(Number, Number) - Method in MathFunctions
Adds the specified number to a value.
add(def) - Method in SubrulesSeq
Wraps the given rule expression into a subrule and adds it to the subrules sequence.
addParameter(String, def) - Method in RulesScript
addProperties(ValidationErrorProperties) - Method in ValidationException
addSkipFunction(String) - Method in SubrulesSeq
and(def) - Method in Operators.ClosureOperators
Creates a validation term that is a conjunction of validation closure and the given term.
and(TildeTerm) - Method in Operators.TermOperators
This method is added to produce an exception when a conjunction is applied to a conversion term.
and(def) - Method in Operators.TildeTermOperators
This method is added to produce an exception when a conjunction is applied to a conversion term.
AndTerm - Class in org.grules.script.expressions
A term which is a conjunction of two other terms.
apply(def) - Method in AndTerm
Checks if both conditions represented by subterms are valid.
apply(def) - Method in BinaryValidationTerm
apply(def) - Method in ClosureTerm
Returns a result of closure application.
apply(def) - Method in FunctionTerm
apply(def) - Method in NotTerm
apply(def) - Method in OrTerm
Checks if at least one condition represented by subterms is valid.
apply(def) - Method in Subrule
Applies the subrule to the given value.
apply(def) - Method in SubrulesSeq
Applies subrules in order.
apply(def) - Method in Term
Applies a term to the given value.
apply(def) - Method in TernaryTerm
{@inheritDoc}
apply(def) - Method in TildeTerm
Returns a result of closure application.
applyGroupRules(Class, Map, Map) - Method in Grules
Runs a rules script against grouped parameters.
applyGroupRules(Class, Map, Map) - Method in GrulesAPI
@see Grules#applyGroupRules(Class, java.util.Map)
applyRules(Class, Map, Map) - Method in Grules
Runs a rules script against non-grouped parameters.
applyRules(Class, Map, Map) - Method in GrulesAPI
@see Grules#applyRules(Class, java.util.Map, java.util.Map)
applyRules() - Method in RulesScript
Runs the script to apply preprocessing rules to input parameters.
applyRuleToOptionalParameter(String, Closure, def) - Method in RulesScript
Applies a preprocessing rule to an optional parameter.
applyRuleToParametersList(String, Set, Map, Closure) - Method in RulesScript
Applies a rule to a list of parameters.
applyRuleToRequiredParameter(String, Closure) - Method in RulesScript
Applies a preprocessing rule to a required parameter.
areIn(List, Set) - Method in CommonFunctions
Checks that all values are members of the set.
AstTransformationConfig - Class in org.grules.config
Configuration used by AST transformations.
AstTransformationConfig(Map) - Constructor in AstTransformationConfig
AstTransformationConfigFactory - Class in org.grules.config
A factory that produces a configuration object used by a compiler during AST transformation.
AstUtils - Class in org.grules.utils

B

BinaryValidationTerm - Class in org.grules.script.expressions
A validation term that combined from two other terms via a boolean operation of arity two, for example disjunction or conjunction.
BinaryValidationTerm(Term, Term) - Constructor in BinaryValidationTerm
bitwiseNegate() - Method in Operators.ClosureOperators
Creates a conversion term.
bitwiseNegate() - Method in Operators.TermOperators
Creates a conversion term.

C

capitalize(String) - Method in StringFunctions
Capitalizes the first letter.
ceil(Double) - Method in MathFunctions
Returns the smallest (closest to negative infinity) double value that is greater than or equal to the argument and is equal to a mathematical integer.
changeGroup(String) - Method in RulesScript
Adds direct parameters variables to script, so they can be accessed without a group prefix, for example: id instead of POST.id
checkBooleanReturnValue(def, Term) - Method in BinaryValidationTerm
CircularIncludeException - Class in org.grules.script
Signals a cycle in rules script inclusion.
CircularIncludeException(List) - Constructor in CircularIncludeException
ClassUtils - Class in org.grules.utils
Provides utility methods for class objects.
close() - Method in GrulesAstTransformation
close() - Method in GrulesASTTransformationLogger
Closes the logger writer.
ClosureTerm - Class in org.grules.script.expressions
A term implemented as a closure.
ClosureTerm(Closure) - Constructor in ClosureTerm
ClosureWrapper - Class in org.grules.ast
Wraps method calls into closures.
collect(List, Closure) - Method in CommonFunctions
Iterates through this aggregate Object transforming each item into a new value using the transform closure, returning a list of transformed values.
CommonFunctions - Class in org.grules.functions.lib
Standard grules converters and validators.
Config - Class in org.grules.config
A common ancestor for configuration classes.
ConfigException - Class in org.grules.config
Signals that some configuration property is invalid.
ConfigFactory - Interface in org.grules.config
The common interface for configuration factories.
ConfigObjectFactory - Class in org.grules.config
The factory creates a configuration object from a groovy file or class.
configure(Binder) - Method in GrulesModule
contains(String, CharSequence) - Method in StringFunctions
Checks that a value contains the specified sequence of char values.
Converter - Annotation Type in org.grules.functions
Indicates that the function is a converter.
ConverterASTTransformation - Class in org.grules.ast
Transformation for a converter function.
ConverterBooleanResult - Class in org.grules.functions
A mixed in class for a converter function return value used to distinguish between validators and boolean converters.
convertPrecedences(Expression) - Method in RuleExpressionFormTransformer
Converts precedences of the ||, &&, and >> operators
convertToRuleExpression(Expression) - Method in RulesAstTransformation
Parses rule expression AST tree and transforms it to a rule expression.
create(Closure, String, String) - Method in DefaultFunctionFactory
Creates a default function based on the given closure, function name, and error message
create(def) - Method in SubruleFactory
The method throws an error for unexpected subrule expression type.
createClosureExpression(BlockStatement) - Method in ExpressionFactory
Creates closure with the specified block statement.
createConfig() - Method in AstTransformationConfigFactory
{@inheritDoc}
createConfig() - Method in ConfigFactory
Creates a configuration based on a script file.
createConfig() - Method in GrulesConfigFactory
Creates a grules configuration based on the script file.
createConfigObject(Config) - Method in ConfigObjectFactory
Creates a configuration object based on the script file located at the given path.
createConstructorCall(Class, List) - Method in ExpressionFactory
Creates a constructor call for the given class and arguments.
createDefaultConfig() - Method in AstTransformationConfigFactory
{@inheritDoc}
createDefaultConfig() - Method in ConfigFactory
Creates default configuration not overridden by custom properties.
createDefaultConfig() - Method in GrulesConfigFactory
Creates default grules configuration object.
createItVariable() - Method in ExpressionFactory
Creates a variable "it".
createLogHandler() - Method in DefaultGrulesConfig
createMethodCall(Expression, MethodClosure, List) - Method in ExpressionFactory
Creates an instance method call.
createStaticMethodCall(Class, MethodClosure, List) - Method in ExpressionFactory
Creates a static method call that calls the given method closure.

D

DateFunctions - Class in org.grules.functions.lib
Converters and validators for dates.
decimalFormat(Long, String) - Method in CommonFunctions
@see java.text.NumberFormat#format(long)
DefaultAstTransformationConfig - Class in org.grules.config
A class with default values of configuration properties used by a compiler during AST transformation.
DefaultAstTransformationConfig() - Constructor in DefaultAstTransformationConfig
DefaultFunctionFactory - Class in org.grules.config
DefaultGrulesConfig - Class in org.grules.config
Default values of grules configuration properties.
DefaultGrulesConfig() - Constructor in DefaultGrulesConfig
div(Number, Number) - Method in MathFunctions
Divides a value by the given number.

E

e(String) - Method in RulesScript
Construct an error properties map.
endsWith(String, String) - Method in StringFunctions
Checks that a value ends with the specified suffix.
eq(def, def) - Method in CommonFunctions
@see isEqual
ExpressionFactory - Class in org.grules.ast
A factory for Groovy expressions used by Grules local and global AST transformations.

F

fetchCleanParameters() - Method in RulesScript
Returns parameters that passed preprocessing by the rules script.
fetchEnvironment() - Method in RulesScript
Returns all script variables that are not parameters.
fetchGroupResult(RulesScript, Map) - Method in RulesScriptResultFetcher
Fetches result of rules application for a script with several sections.
fetchNotValidatedParameters() - Method in RulesScript
Fetches all parameters that were not validated.
fetchOperationToken(Expression) - Method in AstUtils
Returns a token object for operation used in the specified expression on the most top level.
fetchPrecedence(Token) - Method in AstUtils
Returns token precedence.
fetchRequestCookies(HttpServletRequest) - Method in Grules
Creates a map with cookies from the given request object.
fetchRequestCookies(HttpServletRequest) - Method in GrulesAPI
@see Grules#fetchRequestCookies(HttpServletRequest)
fetchRequestHeaders(HttpServletRequest) - Method in Grules
Creates a map with request HTTP headers from the given request object.
fetchRequestHeaders(HttpServletRequest) - Method in GrulesAPI
@see Grules#fetchRequestHeaders(HttpServletRequest)
fetchRequestParameters(HttpServletRequest, List) - Method in Grules
Creates a map with HTTP parameters from the given request object.
fetchRequestParameters(HttpServletRequest, List) - Method in GrulesAPI
@see Grules#fetchRequestParameters(HttpServletRequest, java.util.List)
fetchResult(RulesScript, String, Map) - Method in RulesScriptResultFetcher
Fetches result of rules application for a script with one default section.
fine(def) - Method in GrulesLogger
floor(Double) - Method in MathFunctions
Returns the largest (closest to positive infinity) double value that is less than or equal to the argument and is equal to a mathematical integer.
format(String, Object) - Method in StringFunctions
@see String#format(String, Object...)
Functions - Annotation Type in org.grules.functions
Transforms an instance-style Groovy class to become a static-style class.
FunctionsASTTransformation - Class in org.grules.ast
Transformation for a functions class.
FunctionTerm - Class in org.grules.script.expressions
A term implemented as a function call.
FunctionTerm(MethodClosure) - Constructor in FunctionTerm

G

getAt(ValidationErrorProperties) - Method in Operators.ClosureOperators
Binds a redirect URL to a subrule implemented as a closure.
getAt(ValidationErrorProperties) - Method in Operators.TermOperators
Binds a error properties to a current subrule.
getCleanParameters() - Method in RulesScriptResultAPI
Parameters that passed validation
getCompilerLogPath() - Method in AstTransformationConfig
Path for logs produced by compiler during AST transformations.
getConfig() - Method in GrulesInjector
getDefaultFunctions() - Method in GrulesConfig
Sequence of converters that must be applied to all parameters.
getDefaultGroup() - Method in GrulesConfig
Group to use when no group is specified.
getErrorId() - Method in ValidationErrorProperties
An error code.
getErrorProperty(String) - Method in ValidationErrorProperties
getException() - Method in ValidationErrorProperties
An exception that causes the error.
getGroups() - Method in GrulesConfig
Set of available groups.
getInputElement() - Method in ValidationErrorProperties
A redirect URL that has to used on validation error event.
getInvalidParameters() - Method in RulesScriptResultAPI
Parameters that did no pass validation
getLoggerHandler() - Method in GrulesConfig
Logger handler used by the rule engine.
getLogLevel() - Method in GrulesConfig
Level of logging used by the rule engine.
getMessage() - Method in ValidationErrorProperties
An error message string.
getMessageResourceBundle() - Method in GrulesInjector
getMissingRequiredParameters() - Method in RulesScriptResultAPI
Parameters that are missing from input but required by a rules script.
getNotValidatedParameters() - Method in RulesScriptResultAPI
Parameters for which a preprocessing rule was not found
getNotValidatedParametersAction() - Method in GrulesConfig
Action performed when there is no defined rule for some input parameter.
getParameter() - Method in ValidationErrorProperties
A name of the parameter that did not pass validation.
getParameters() - Method in AstTransformationConfig
{@inheritDoc}
getParameters() - Method in Config
Returns a map with configuration properties.
getParameters() - Method in GrulesConfig
{@inheritDoc}
getParameters() - Method in NotValidatedParametersException
getParametersWithMissingDependency() - Method in RulesScriptResultAPI
Parameters that depend on other parameters that are invalid or missing from input.
getRedirectUrl() - Method in ValidationErrorProperties
A redirect URL that has to used on validation error event.
getResourceBundlePath() - Method in GrulesConfig
Resource bundle for error messages.
getRuleEngine() - Method in GrulesInjector
getSubruleIndex() - Method in ValidationErrorProperties
An index of a failed subrule.
getTerm() - Method in UnaryTerm
getValue() - Method in ValidationErrorProperties
Value of an invalid property.
getVariables() - Method in RulesScript
Script variables.
getVariables() - Method in RulesScriptResultAPI
Script variables that are not inpit parameters
Grules - Class in org.grules
The main class for interacting with grules functionality.
GrulesAPI - Class in org.grules
@see Grules
GrulesAstTransformation - Class in org.grules.ast
The class is common ancestor for grules script transformations.
GrulesASTTransformationLogger - Class in org.grules.ast
A logger for grules script transformations.
GrulesASTTransformationLogger(String) - Constructor in GrulesASTTransformationLogger
GrulesConfig - Class in org.grules.config
Grules configuration parameters.
GrulesConfig(Map) - Constructor in GrulesConfig
GrulesConfigFactory - Class in org.grules.config
The factory creates a grules configuration object from a groovy file or class.
GrulesException - Class in org.grules
A common ancestor for grules exceptions.
GrulesInjector - Class in org.grules
A Guice injector for service classes.
GrulesLogger - Class in org.grules
A common logger for all rule engine events.
GrulesModule - Class in org.grules
The main Guice module.
gt(Number, Number) - Method in MathFunctions
@see isGreater
gte(Number, Number) - Method in MathFunctions
@see isGreaterEq

H

hasAction() - Method in ValidationErrorProperties
Checks if the validation error specifies any action that should be takes on validation error event.
hasAnnotation(Expression, Class) - Method in AstUtils
hasErrorId() - Method in ValidationErrorProperties
Checks if the validation error specifies an error id.
hasErrorProperty(String) - Method in ValidationErrorProperties
hasInputElement() - Method in ValidationErrorProperties
Checks if the validation error specifies an input element that has to used on validation error event.
hasMessage() - Method in ValidationErrorProperties
Checks if the validation error specifies an error message that has to be shown on validation error event.
hasMixin(def, Class) - Method in ClassUtils
hasRedirectUrl() - Method in ValidationErrorProperties
Checks if the validation error specifies a redirect URL that has to used on validation error event.
hasSkipFunction(Subrule) - Method in SubrulesSeq
hasValue() - Method in ValidationErrorProperties
Checks if the validation error specifies a property value.
HttpRequestParametersGroup - Enum in org.grules.http
Types of possible HTTP parameters.

I

include(Class) - Method in RulesScript
Includes a rules script from a given class into this script.
info(def) - Method in GrulesLogger
init(String) - Method in GrulesAstTransformation
Initializes a transformation class.
initInclude(Script, GrulesConfig, RuleEngine, List, Map, Map, Map, Set) - Method in RulesScript
Initialize a script included into another rules script.
initMain(Script, GrulesConfig, RuleEngine, Map, Map) - Method in RulesScript
Initialize a main rules script that includes all others.
InvalidBooleanTermException - Class in org.grules.script.expressions
Thrown to indicate that the term returns not a boolean type.
InvalidBooleanTermException(def, String) - Constructor in InvalidBooleanTermException
InvalidDependencyValueException - Class in org.grules.script
Signals that value on which a rule depends is invalid.
InvalidGroupException - Class in org.grules.script
Signals that the group is not declared in configuration file.
InvalidGroupException(String) - Constructor in InvalidGroupException
InvalidSubruleException - Class in org.grules.script.expressions
Signals an invalid subrule expression.
InvalidSubruleException(def) - Constructor in InvalidSubruleException
InvalidSubrulesSeqException - Class in org.grules.script.expressions
Signals an invalid subrules sequence.
InvalidSubrulesSeqException(def) - Constructor in InvalidSubrulesSeqException
InvalidTermException - Class in org.grules.script.expressions
Signals an invalid term expression.
InvalidTermException(def) - Constructor in InvalidTermException
InvalidValidatorException - Class in org.grules.script.expressions
Signals an invalid validator.
InvalidValidatorException(def, String, String) - Constructor in InvalidValidatorException
inverse(Boolean) - Method in CommonFunctions
Returns an opposite value wrapped into ConverterBooleanResult: true for false and false for true.
isAfter(Date, Date) - Method in DateFunctions
Check that a date is after the specified one.
isAfterNow(Date) - Method in DateFunctions
Check that a date is after now.
isAlpha(String) - Method in StringFunctions
Checks that a string matches /[a-zA-Z]+/.
isAlphanum(String) - Method in StringFunctions
Checks that a string matches /[a-zA-Z0-9]+/.
isAlphanumSpace(String) - Method in StringFunctions
Checks that a string matches /[a-zA-Z0-9\s]+/.
isAlphaSpace(String) - Method in StringFunctions
Checks that a string matches /[a-zA-Z\s]+/.
isAny(List, Closure) - Method in CommonFunctions
Checks that at least one member is valid according to the predicate.
isArrayItemExpression(Expression) - Method in AstUtils
Checks if the specified expression is an array item expression.
isBefore(Date, Date) - Method in DateFunctions
Check that a date is before the specified one
isBeforeNow(Date) - Method in DateFunctions
Check that a date is before now.
isBetween(Integer, IntRange) - Method in MathFunctions
Checks that a value falls within the specified integer range.
isBirthDateAlive(Date) - Method in DateFunctions
Check that a date is before the current year (or the current one) but not more than 120 years in the past.
isBirthYearAlive(Integer) - Method in DateFunctions
Check that a year is before the current year (or the current one) but not more than 120 years in the past.
isEmail(String) - Method in UserFunctions
Validate that this address conforms to the syntax rules of RFC 822.
isEmpty(String) - Method in CommonFunctions
Checks that the string matches \/\s*\/.
isEqual(def, def) - Method in CommonFunctions
Checks that a value is equal to the specified object.
isEven(Long) - Method in MathFunctions
Checks that a value is even.
isEvery(List) - Method in CommonFunctions
Checks that all list members are true according to the Groovy Truth.
isFalse(def) - Method in CommonFunctions
Checks that a value coerces to boolean false.
isGreater(Number, Number) - Method in MathFunctions
Checks that a value is greater than the specified number.
isGreaterEq(Number, Number) - Method in MathFunctions
Checks that a value is greater or equal to the specified number.
isIn(def, Set) - Method in CommonFunctions
Checks that a value is equal to any member of the specified set.
isLengthBetween(String, Integer, Integer) - Method in StringFunctions
Checks that a value string length is within the specified range (the range is inclusive).
isLengthEq(String, Integer) - Method in StringFunctions
Checks that a value has the specified string length.
isLengthLess(String, Integer) - Method in StringFunctions
Checks that a value has a string length less than the specified length.
isLengthLessEq(String, Integer) - Method in StringFunctions
Checks that a value has a string length less or equal to specified length.
isLengthMore(String, Integer) - Method in StringFunctions
Checks that a value has a string length more than the specified length.
isLengthMoreEq(String, Integer) - Method in StringFunctions
Checks that a value has a string length more or equal to specified length.
isLess(Number, Number) - Method in MathFunctions
Checks that a value is less than the specified number.
isLessEq(Number, Number) - Method in MathFunctions
Checks that a value is less or equal to the specified number.
isMultithreadingEnabled() - Method in GrulesConfig
Checks whether scripts should be evaluated in multi-threaded environment.
isNonnegative(Number) - Method in MathFunctions
Checks that a value is a nonnegative number.
isOdd(Long) - Method in MathFunctions
Checks that a value is odd.
isPositive(Number) - Method in MathFunctions
Checks that a value is a positive number.
isRightShift(Expression) - Method in AstUtils
Checks if the specified expression is a right shift expression.
isStrongPassword(String, List, List) - Method in UserFunctions
Checks that the value is compliant with a strong password policy.
isTrue(def) - Method in CommonFunctions
Checks that a value coerces to boolean true.

J

join(Collection, String) - Method in CommonFunctions
@see DefaultGroovyMethods#join(java.util.Collection, String)

K


L

leftTerm - Field in BinaryValidationTerm
log(String, def) - Method in GrulesAstTransformation
Writes a message to a log.
logSource(MethodNode) - Method in GrulesAstTransformation
lt(Number, Number) - Method in MathFunctions
@see isLess
lte(Number, Number) - Method in MathFunctions
@see isLessEq

M

MapUtils - Class in org.grules.utils
matches(String, String) - Method in StringFunctions
Checks that a value is a string that matches the specified regex.
MathFunctions - Class in org.grules.functions.lib
Standard grules converters and validators.
merge(ValidationErrorProperties) - Method in ValidationErrorProperties
minus(Number, Number) - Method in MathFunctions
Substracts number from a value (same as {it + number})
MissingParameterException - Class in org.grules.script
Signals that a required parameter was not supplied.
MissingParameterException(String, String) - Constructor in MissingParameterException
mod(Long, Long) - Method in MathFunctions
Returns a value modulo number.
mult(Number, Number) - Method in MathFunctions
Multiplies a value by number.

N

negative() - Method in Operators.ClosureOperators
Creates a validation term that is a negation of the given closure.
negative() - Method in Operators.TermOperators
Creates a validation term that is a negation of itself.
negative() - Method in Operators.TildeTermOperators
This method is added to produce an exception when a negation is applied to a conversion term.
newExecutor(Class, Map) - Method in RuleEngine
Creates a closure that applies a rules script to given parameters values.
newGroupExecutor(Class, Map) - Method in RuleEngine
Creates a closure that applies a rules script to given parameters values.
newGroupRulesApplicator(Class, Map) - Method in Grules
Creates a closure that runs a given rules script against passed parameters (grouped).
newGroupRulesApplicator(Class, Map) - Method in GrulesAPI
@see Grules#newGroupRulesApplicator(Class, java.util.Map)
newInstanceIncluded(Class, List, Binding, Map, Map, Map, Set) - Method in RulesScriptFactory
Creates a script that is included into another rules script.
newInstanceMain(Class, Map, Map) - Method in RulesScriptFactory
Creates a main rules script that includes all others.
newRulesApplicator(Class, Map) - Method in Grules
Creates a closure that runs a given rules script against passed parameters (ungrouped).
newRulesApplicator(Class, Map) - Method in GrulesAPI
@see Grules#newRulesApplicator(Class, java.util.Map)
nolog(String) - Method in RulesScript
nop(def) - Method in CommonFunctions
Returns the passed value. s
NotTerm - Class in org.grules.script.expressions
A term that represents a negation operator on a validation term.
NotTerm(Closure) - Constructor in NotTerm
NotValidatedParametersException - Class in org.grules.script
Signals that to some parameters preprocessing rules were not applied.
NotValidatedParametersException(String) - Constructor in NotValidatedParametersException
NotValidatedParametersFlatException - Class in org.grules.script
NotValidatedParametersException for rules script with one default group.
NotValidatedParametersFlatException(Map) - Constructor in NotValidatedParametersFlatException
NotValidatedParametersGroupException - Class in org.grules.script
NotValidatedParametersException for a rules script with several groups.
NotValidatedParametersGroupException(Map) - Constructor in NotValidatedParametersGroupException
nullToEmpty(Map) - Method in MapUtils
Converts null to an empty map or returns the original map if it is not null.
nullToEmpty(Set) - Method in SetUtils
Converts null to an empty set or returns the original set if it is not null.

O

OnValidationEventAction - Enum in org.grules.config
Operators - Class in org.grules.script.expressions
Operators used in rule expressions: and, or, chaining operator (>>), binding an error ([])
Operators.ClosureOperators - Class in org.grules.script.expressions
Operators.SubrulesSeqOperators - Class in org.grules.script.expressions
>> operator that combines two subrules in a sequence such that a result of application of a first subrule is passed to a second subrule.
Operators.TermOperators - Class in org.grules.script.expressions
Operators.TildeTermOperators - Class in org.grules.script.expressions
or(def) - Method in Operators.ClosureOperators
Creates a validation term that is a disjunction of validation closure and the given term.
or(TildeTerm) - Method in Operators.TermOperators
This method is added to produce an exception when a disjunction is applied to a conversion term.
or(def) - Method in Operators.TildeTermOperators
This method is added to produce an exception when a disjunction is applied to a conversion term.
OrTerm - Class in org.grules.script.expressions
A term which is a disjunction of two other terms.

P

Parameter - Annotation Type in org.grules.script
Indicates that the variable is a parameter.
PasswordStrength - Enum in org.grules.functions.lib
Enum used by the CommonFunctions.isStrongPassword validator.
pow(Double, Double) - Method in MathFunctions
Returns a value raised to the power exponent.
propertyMissing(String, String) - Method in RulesScript
Handles reading of missing parameters and clean values.

Q


R

replaceAll(String, String, String) - Method in StringFunctions
Replaces each substring of a string value that matches the given regular expression with the given replacement.
rightShift(def) - Method in Operators.SubrulesSeqOperators
rightTerm - Field in BinaryValidationTerm
round(Double) - Method in MathFunctions
Returns the closest long to the argument, with ties rounding up.
Rule - Annotation Type in org.grules.script
Indicates that the variable is a rule.
RuleEngine - Class in org.grules.script
The RuleEngine class manages execution of rules scripts.
RuleEngine(GrulesConfig, RulesScriptFactory) - Constructor in RuleEngine
RuleExpressionFormTransformer - Class in org.grules.ast
Transforms a rule expression between tree, infix, and postfix forms.
RulesAstTransformation - Class in org.grules.ast
Transformations of an abstract syntax tree for rules scripts.
RulesAstTransformation(String) - Constructor in RulesAstTransformation
RulesScript - Class in org.grules.script
Encapsulates state of a rules script.
RulesScriptFactory - Class in org.grules.script
Factory for rules scripts.
RulesScriptGroupResult - Class in org.grules.script
RulesScriptResult - Class in org.grules.script
RulesScriptResultAPI - Class in org.grules.script
A tuple class for result of rules application.
RulesScriptResultFetcher - Class in org.grules.script
Encapsulates a result of application of preprocessing rules: - required but missing parameters - invalid parameters - parameters that did not pass validation - parameters that depend on a value of another missing parameter
runIncludedScript(Class, List, Binding, Map, Map, Map, Set) - Method in RuleEngine
Runs an included rules script.

S

Security - Annotation Type in org.grules.functions
SecurityFunctions - Class in org.grules.functions.lib
setErrorId(def) - Method in ValidationErrorProperties
Sets an error id.
setException(Exception) - Method in ValidationErrorProperties
Sets an exception.
setLowerLimit(Number, Number) - Method in MathFunctions
setMessage(String) - Method in ValidationErrorProperties
Sets an error message string.
setSubruleIndex(Integer) - Method in ValidationErrorProperties
Sets an index of a failed subrule.
setUpperLimit(Number, Number) - Method in MathFunctions
SetUtils - Class in org.grules.utils
setValue(def) - Method in ValidationErrorProperties
Sets value of an invalid property.
Skip - Class in org.grules.script.expressions
skip(String) - Method in RulesScript
Skip(String) - Constructor in Skip
startsWith(String, String) - Method in StringFunctions
Checks if a value starts with the specified prefix.
StringFunctions - Class in org.grules.functions.lib
Converters and validators for strings.
Subrule - Class in org.grules.script.expressions
A subrule expression (parts of a rule between ">>" operators).
Subrule(Term, ValidationErrorProperties) - Constructor in Subrule
SubruleFactory - Class in org.grules.script.expressions
Factory for conversion and validation subrules.
SubrulesSeq - Class in org.grules.script.expressions
A sequence of subrules.
SubrulesSeqWrapper - Class in org.grules.script.expressions
substring(String, Integer, Integer) - Method in StringFunctions
Returns a new string that is a substring of this string.

T

Term - Interface in org.grules.script.expressions
A rule term.
TermWrapper - Class in org.grules.script.expressions
Wraps a closure into a term.
TernaryRuleExpression - Class in org.grules.ast
TernaryTerm - Class in org.grules.script.expressions
A term implemented as a ternary operator.
TernaryTerm(Closure, Closure, Closure) - Constructor in TernaryTerm
Creates a ternary term.
TildeTerm - Class in org.grules.script.expressions
A conversion term for boolean expressions.
TildeTerm(Term) - Constructor in TildeTerm
toBigDecimal(String) - Method in TypeFunctions
Parse a String into a BigDecimal.
toBigDecimalList(List) - Method in TypeFunctions
Converts a list of string to a list of big decimals.
toBoolean(def) - Method in TypeFunctions
Returns true if a value coerces to true and false otherwise.
toBooleanList(List) - Method in TypeFunctions
Returns a list of booleans, whose elements identify which elements of the specified values list coerce to true.
toChar(String) - Method in TypeFunctions
Returns the first string character.
toCharList(List) - Method in TypeFunctions
Converts a list of string to a list of integers.
toDate(String, String, Locale) - Method in TypeFunctions
Parses a value to produce a date.
toDouble(String) - Method in TypeFunctions
Parse a String into a Double.
toDoubleList(List) - Method in TypeFunctions
Converts a list of string to a list of doubles.
toEnum(String, Class) - Method in TypeFunctions
Returns the enum constant of the specified enum type with the specified name.
toFloat(String) - Method in TypeFunctions
Parse a String into a Float.
toFloatList(List) - Method in TypeFunctions
Converts a list of string to a list of floats.
toInt(String) - Method in TypeFunctions
Parse a String into an Integer.
toIntList(List) - Method in TypeFunctions
Converts a list of string to a list of integers.
toLong(String) - Method in TypeFunctions
Parse a String into a Long.
toLongList(List) - Method in TypeFunctions
Converts a list of string to a list of longs.
toLowerCase(String) - Method in StringFunctions
Converts all of the characters in a value to lower case using the rules of the default locale.
toNaturalInt(String) - Method in TypeFunctions
Parse a String into a natural Integer.
toNaturalLong(String) - Method in TypeFunctions
Parse a String into a natural Long.
toNonnegativeBigDecimal(String) - Method in TypeFunctions
Parse a String into a nonnegative BigDecimal.
toNonnegativeDouble(String) - Method in TypeFunctions
Parse a String into a nonnegative Double.
toNonnegativeFloat(String) - Method in TypeFunctions
Parse a String into a nonnegative Float.
toPositiveBigDecimal(String) - Method in TypeFunctions
Parse a String into a positive BigDecimal.
toPositiveDouble(String) - Method in TypeFunctions
Parse a String into a positive Double.
toPositiveFloat(String) - Method in TypeFunctions
Parse a String into a positive Float.
toPositiveInt(String) - Method in TypeFunctions
Parse a String into a positive Integer.
toPositiveLong(String) - Method in TypeFunctions
Parse a String into a positive Long.
toString() - Method in Config
Returns all configuration parameters as a string.
toString() - Method in FunctionTerm
toString() - Method in RulesScript
toString() - Method in RulesScriptResultAPI
toString() - Method in Subrule
toString() - Method in SubrulesSeq
toString() - Method in ValidationErrorProperties
toUpperCase(String) - Method in StringFunctions
Converts all of the characters in a value to upper case using the rules of the default locale.
trim(def) - Method in StringFunctions
An additional trim method to make it usable as a default converter.
turnOff() - Method in GrulesLogger
TypeFunctions - Class in org.grules.functions.lib
Standard type converters.

U

UnaryTerm - Class in org.grules.script.expressions
A term that consists of an operator and a term to which it has to be applied, for example a negation operator.
UnsupportedExpressionException - Class in org.grules.ast
Signals an invalid rule expression.
UnsupportedExpressionException(Class) - Constructor in UnsupportedExpressionException
UserFunctions - Class in org.grules.functions.lib

V

validate(Closure) - Method in RulesScript
A validation block.
ValidationErrorProperties - Class in org.grules
ValidationErrorProperties(def, String, String) - Constructor in ValidationErrorProperties
ValidationException - Class in org.grules
Signals a validation error.
ValidationException(Map) - Constructor in ValidationException
visit(ASTNode, SourceUnit) - Method in ConverterASTTransformation
Visits a converter method.
visit(ASTNode, SourceUnit) - Method in FunctionsASTTransformation
visit(ModuleNode, def) - Method in GrulesAstTransformation
Visits the module node and applies AST transformations.
visit(ASTNode, SourceUnit) - Method in RulesAstTransformation
Visits a rules script class and applies appropriate transformations.
visitModule(ModuleNode, def) - Method in ConverterASTTransformation
Mixins ConverterBooleanResult to a method return value to so the method can be used as a converter.
visitModule(ModuleNode, def) - Method in FunctionsASTTransformation
Visits each method and makes it static.
visitModule(ModuleNode, def) - Method in GrulesAstTransformation
visitModule(ModuleNode, def) - Method in RulesAstTransformation

W

warn(def) - Method in GrulesLogger
wrap(def) - Method in SubrulesSeqWrapper
An unexpected subrules sequence.
wrap(def) - Method in TermWrapper
An unexpected expression type.
wrapInClosures(Expression) - Method in ClosureWrapper
Expressions of unsupported types are not wrapped.
write(String) - Method in GrulesASTTransformationLogger
Write the specified message to a log.
writer - Field in GrulesASTTransformationLogger

X


Y


Z


_


Groovy Documentation