core/com.tealium.prism.core.api.rules

Package-level declarations

Types

data class Condition : DataItemConvertible, Matchable<DataObject>

A class modelling the possible conditions used by both transformations and load rules to determine whether or not to execute.

ConditionEvaluationException

class ConditionEvaluationException(val condition: Condition, message: String, cause: Throwable? = null) : InvalidMatchException

Exception class to signify that a Condition has failed in an exceptional way during evaluation.

InvalidMatchException

abstract class InvalidMatchException(message: String? = null, cause: Throwable? = null) : RuntimeException

Exception class to signify that the Matchable has failed in an exceptional way, as opposed to having not matched the input.

Matchable

fun interface Matchable<T>

Matchable is a generic interface for checking whether an input matches an expectation.

MissingDataItemException

class MissingDataItemException(message: String = "DataItem not found.") : OperatorFailedException

Indicates that the DataItem was not found whilst evaluating the Condition.operator

MissingFilterException

class MissingFilterException(message: String = "Filter cannot be null.") : OperatorFailedException

Indicates that the Condition.filter was required, but was unavailable.

NumberParseException

class NumberParseException(message: String, cause: Throwable? = null) : OperatorFailedException

Indicates that a numeric type was expected, but was not found or was not parseable to a numeric type

OperatorFailedException

abstract class OperatorFailedException(message: String, cause: Throwable? = null) : RuntimeException

Base exception for exceptions thrown by Operator implementations. This exception is used to denote that an Operator has completed exceptionally, and is therefore unable to return a valid true/false result.

Rule

sealed class Rule<T> : DataItemConvertible

Simple Rule builder class for building out logical rules, that can be serialized to a DataItem The type of T should therefore either implement DataItemConvertible or be one of the types supported by DataItem

RuleNotFoundException

class RuleNotFoundException(message: String, cause: Throwable? = null) : InvalidMatchException

Indicates that a rule was configured for a module, but was not found. This will cause the module feature (collection/dispatching etc) not to happen.

UnsupportedOperatorException

class UnsupportedOperatorException(message: String, cause: Throwable?) : OperatorFailedException

Indicates that an operator was applied to an unsupported input type. Not all Condition.Operator implementations are supported for all input types.

Functions

asMatchable

fun <T : Matchable<R>, R> Rule<T>.asMatchable(): Matchable<R>

Convenience method to convert a Rule to a Matchable

matches

fun <T : Matchable<R>, R> Rule<T>.matches(input: R): Boolean

Convenience method to determine if a Rule is satisfied by the given input.