bt.bencoding.model.rule

Class ExclusiveRule

java.lang.Object

bt.bencoding.model.rule.ExclusiveRule

All Implemented Interfaces:

Rule

public class ExclusiveRule
extends Object
implements Rule

Used to mark a subset of the model's attributes as mutually exclusive.

Exclusive attributes can also be marked as required via RequiredRule. In such case exclusiveness is checked first. The exclusiveness condition is satisfied when either one of the following applies:

• the object has only one of the mutually exclusive attributes
• the object has neither of the mutually exclusive attributes

In the latter case an additional check is performed whether any of the mutually exclusive attributes is also marked as required.

E.g. if:

• a model M defines attributes A, B and C,
• and attributes {B, C} are mutually exclusive,
• and attributes {A, C} are required,

then only the following types of objects will be allowed by model M:

• having attributes A and C
• having attributes A and B

The following types of objects will be disallowed by model M:

• having only a single attribute (any of {A, B, C})
• having all attributes A, B and C
• having only attibutes B and C (failing by exclusiveness rule, because it's applied first)

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ExclusiveRule(Collection<Set<String>> exclusives)
ExclusiveRule(Collection<Set<String>> exclusives, List<String> required)

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	toString()
boolean	validate(Object object) Validate a given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExclusiveRule

public ExclusiveRule(Collection<Set<String>> exclusives,
                     List<String> required)

Parameters:

exclusives - Collection of sets of mutually exclusive attributes.

required - List of required attributes (in the order in which attributes should be checked).

Since:

1.0

ExclusiveRule

public ExclusiveRule(Collection<Set<String>> exclusives)

Parameters:

exclusives - Collection of sets of mutually exclusive attributes.

Since:

1.0

Method Detail

validate

public boolean validate(Object object)

Description copied from interface: Rule

Validate a given object.

Specified by:

validate in interface Rule

Parameters:

object - Arbitrary object

Returns:

true if the object satisfies this rule's condition.

getDescription

public String getDescription()

Specified by:

getDescription in interface Rule

Returns:

Human-readable description of this rule.

toString

public String toString()

Overrides:

toString in class Object