com.mobsandgeeks.saripaar

Class AnnotationRule<RULE_ANNOTATION extends java.lang.annotation.Annotation,DATA_TYPE>

java.lang.Object

com.mobsandgeeks.saripaar.Rule<DATA_TYPE>

com.mobsandgeeks.saripaar.AnnotationRule<RULE_ANNOTATION,DATA_TYPE>

Type Parameters:

RULE_ANNOTATION - The associated rule Annotation.

DATA_TYPE - The data type this rule operates on.

Direct Known Subclasses:

AssertFalseRule, AssertTrueRule, CheckedRule, ContextualAnnotationRule, CreditCardRule, DecimalMaxRule, DecimalMinRule, DigitsRule, DomainRule, EmailRule, IpAddressRule, IsbnRule, LengthRule, MaxRule, MinRule, PasswordRule, PatternRule, SelectRule, UrlRule

public abstract class AnnotationRule<RULE_ANNOTATION extends java.lang.annotation.Annotation,DATA_TYPE>
extends Rule<DATA_TYPE>

Saripaar Annotations have an AnnotationRule paired to them, via the ValidateUsing annotation. Like stock annotations, custom annotations must also have a corresponding AnnotationRule.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected RULE_ANNOTATION	mRuleAnnotation

Fields inherited from class com.mobsandgeeks.saripaar.Rule

mSequence

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnnotationRule(RULE_ANNOTATION ruleAnnotation) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getMessage(android.content.Context context) Returns a failure message associated with the rule.

Methods inherited from class com.mobsandgeeks.saripaar.Rule

getSequence, isValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mRuleAnnotation

protected final RULE_ANNOTATION extends java.lang.annotation.Annotation mRuleAnnotation

Constructor Detail

AnnotationRule

protected AnnotationRule(RULE_ANNOTATION ruleAnnotation)

Constructor. It is mandatory that all subclasses MUST have a constructor with the same signature.

Parameters:

ruleAnnotation - The rule Annotation instance to which this rule is paired.

Method Detail

getMessage

public java.lang.String getMessage(android.content.Context context)

Returns a failure message associated with the rule.

Specified by:

getMessage in class Rule<DATA_TYPE>

Parameters:

context - Any Context instance, usually an Activity.

Returns:

A failure message.