ch.awae.utils.logic

Class LogicGroup

java.lang.Object

ch.awae.utils.logic.LogicGroup

public final class LogicGroup
extends java.lang.Object

Groups a list of Logic instances. A LogicGroup must consist of at least one member. This is enforced during creation.

Since:

awaeUtils 0.0.6

Author:

Andreas Wälchli

See Also:

Logic

Constructor Summary

Constructors

Constructor and Description
LogicGroup(Logic[] members) Creates a new Logic group

Method Summary

Modifier and Type	Method and Description
Logic	all() Creates a Logic instance over the group, defined by Logic.all(Logic...).
Logic	any() Creates a Logic instance over the group, defined by Logic.any(Logic...).
Logic	count(int target) Creates a Logic instance over the group, defined by Logic.count(int, Logic...).
LogicGroup	merge(LogicGroup other) Merges this LogicGroup with another one and returns a new LogicGroup containing the members from both this and the other group.
Logic	none() Creates a Logic instance over the group, defined by Logic.none(Logic...).
int	size()
Logic	strict(LogicGroup domain) Strict group evaluation on a restricted domain.
Logic[]	toArray() Provides an array containing all group members

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicGroup

public LogicGroup(Logic[] members)

Creates a new Logic group

Parameters:

members - the group members

Throws:

java.lang.NullPointerException - if the members array is null or contains any null elements

java.lang.IllegalArgumentException - if the members array is empty

Method Detail

toArray

public Logic[] toArray()

Provides an array containing all group members

Returns:

an array of all members

any

public Logic any()

Creates a Logic instance over the group, defined by Logic.any(Logic...).

Returns:

the created logic instance

all

public Logic all()

Creates a Logic instance over the group, defined by Logic.all(Logic...).

Returns:

the created logic instance

none

public Logic none()

Creates a Logic instance over the group, defined by Logic.none(Logic...).

Returns:

the created logic instance

count

public Logic count(int target)

Creates a Logic instance over the group, defined by Logic.count(int, Logic...).

Parameters:

target - the exact number of group members to evaluate to true for the created Logic instance to evaluate to true

Returns:

the created logic instance

Throws:

java.lang.IllegalArgumentException - if the target value is negative or larger than the group size

See Also:

Logic.count(int, Logic...)

size

public int size()

Returns:

the size of the group

merge

public LogicGroup merge(LogicGroup other)

Merges this LogicGroup with another one and returns a new LogicGroup containing the members from both this and the other group. There are no duplicate checks present, therefore this should only be used for disjoint groups.

Parameters:

other - the group to merge this group with

Returns:

a combined group

strict

public Logic strict(LogicGroup domain)

Strict group evaluation on a restricted domain. The generated Logic instance evaluates to true iff all elements of this group evaluate to true (i.e. this.all() == true) and the given domain has n elements that evaluate to true, where n == this.size(). There are no checks done, therefore one must ensure that provided domain is a superset of this group. This allows to check if from a given domain exactly the elements of this group evaluate to true.

Parameters:

domain - the domain to restrict over.

Throws:

java.lang.NullPointerException - the domain is null