hu.elte.eserial.annotation.inclusionrule

Class AbstractInclusionRule<A>

java.lang.Object

hu.elte.eserial.annotation.inclusionrule.AbstractInclusionRule<A>

Type Parameters:

A - the type of annotation this rule applies to

Direct Known Subclasses:

ExcludeThisInclusionRule, IncludeElementsInclusionRule, IncludeMatchingInclusionRule

public abstract class AbstractInclusionRule<A>
extends java.lang.Object

An abstract class for evaluating EserialAnnotation EserialAnnotationType.INCLUSION constraints.

Field Summary

Fields

Modifier and Type	Field and Description
protected A	annotation

Method Summary

Modifier and Type	Method and Description
abstract boolean	evaluate(EserialElement element) An element of an object which will be evaluated.
abstract boolean	isInclusionRule() Describes whether this rule is an inclusion or an exclusion rule. For inclusion rules the processing should be stopped when the evaluate(hu.elte.eserial.model.EserialElement) returns true. For exclusion rules the processing should be stopped when the evaluate(hu.elte.eserial.model.EserialElement) returns false.

Methods inherited from class java.lang.Object

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

Field Detail

annotation

protected A annotation

Method Detail

evaluate

public abstract boolean evaluate(EserialElement element)

An element of an object which will be evaluated.

Parameters:

element - an element containing the getter or setter to be checked and the value of the field

Returns:

true if the element should be included according to the EserialAnnotation

isInclusionRule

public abstract boolean isInclusionRule()

Describes whether this rule is an inclusion or an exclusion rule.

For inclusion rules the processing should be stopped when the evaluate(hu.elte.eserial.model.EserialElement) returns true.
For exclusion rules the processing should be stopped when the evaluate(hu.elte.eserial.model.EserialElement) returns false.

Returns:

true if this is an inclusion rule, false if it's an exclusion rule