Choices (Team33 Decision Library - Edition "thyone" 1.27.0 API)

java.lang.Object
- de.team33.patterns.decision.thyone.Choices

```
public abstract class Choices
extends Object
```
Abstracts the choices resulting from a combination of boolean criteria with respect to an input of type .
When evaluating a specific input, a single choice is represented as an int value, which can be used as a decision criterion in, for example, a switch statement.
To get an instance, use either serial(Predicate[]), serial(Collection), parallel(Predicate[]) or parallel(Collection).

Constructor Summary

Constructors
Constructor and Description

Choices()

Constructors
Constructor and Description
`Choices()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`<R> Function<I,R>`	`andThen(IntFunction<? extends R> function)` Returns a `Function` that maps an input of type `<I>` to a result of type `<R>` based on this `Choices` and a given function that maps an `int` to a result of type `<R>`.
`abstract int`	`apply(I input)` Returns an `int` value representing the combined results of the associated boolean criteria.
`<R> Function<I,R>`	`applying(Collection<? extends Function<? super I,? extends R>> methods)` Returns a `Function` that maps an input of type `<I>` to one of the given methods to finally get a result of type `<R>`.
`<R> Function<I,R>`	`applying(Function<? super I,? extends R>... methods)` Returns a `Function` that maps an input of type `<I>` to one of the given methods to finally get a result of type `<R>`.
`static <I> Choices<I>`	`parallel(Collection<? extends Predicate<? super I>> criteria)` Retrieves a new instance consisting of a combination of boolean criteria.
`static <I> Choices<I>`	`parallel(Predicate<I>... criteria)` Retrieves a new instance consisting of a combination of boolean criteria.
`<R> Function<I,R>`	`replying(Collection<? extends R> results)` Returns a `Function` that maps an input of type `<I>` to one of the given results of type `<R>`.
`<R> Function<I,R>`	`replying(R... results)` Returns a `Function` that maps an input of type `<I>` to one of the given results of type `<R>`.
`static <I> Choices<I>`	`serial(Collection<? extends Predicate<? super I>> criteria)` Retrieves a new instance consisting of a series of boolean criteria.
`static <I> Choices<I>`	`serial(Predicate<I>... criteria)` Retrieves a new instance consisting of a series of boolean criteria.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - Choices
```
public Choices()
```
- Method Detail
 - serial
```
@SafeVarargs
public static  Choices serial(Predicate... criteria)
```
 Retrieves a new instance consisting of a series of boolean criteria.
 When evaluating a specific input, the criteria will be evaluated just like in a series of if-else-statements ...
```
 final int n = criteria.length;
 if (criteria[0].test(input)) {
 return 0;
 } else if (criteria[1].test(input)) {
 return 1;
 } else if (criteria[2].test(input)) {
 return 2;
 } [...]
 else if (criteria[n-1].test(input)) {
 return n-1;
 } else {
 return n;
 }
 
```
 Let n be the number of given criteria, then n+1 is the number of possible results when evaluating an input. More precisely, the result range is between 0 and n (inclusive).
 - serial
```
public static  Choices serial(Collection<? extends Predicate<? super I>> criteria)
```
 Retrieves a new instance consisting of a series of boolean criteria.
 See serial(Predicate[]) for more details.
 
 Parameters:
 
 criteria - CAUTION: be careful with Collections other than Lists: The effective number and order of elements will be significant!
 - parallel
```
@SafeVarargs
public static  Choices parallel(Predicate... criteria)
```
 Retrieves a new instance consisting of a combination of boolean criteria.
 When evaluating a specific input, all criteria are always evaluated and each represented by a specific bit (MSB first) of the resulting int, in principle as in the following case of three criteria ...
```
 if (criteria[0].test(input)) {
 if (criteria[1].test(input)) {
 if (criteria[2].test(input)) {
 return 0b111;
 } else {
 return 0b110;
 }
 } else {
 if (criteria[2].test(input)) {
 return 0b101;
 } else {
 return 0b100;
 }
 }
 } else {
 if (criteria[1].test(input)) {
 if (criteria[2].test(input)) {
 return 0b011;
 } else {
 return 0b010;
 }
 } else {
 if (criteria[2].test(input)) {
 return 0b001;
 } else {
 return 0b000;
 }
 }
 }
 
```
 Let n be the number of given criteria, then 2ⁿ is the number of possible results when evaluating an input. More precisely, the result range is between 0 and 2ⁿ-1 (inclusive).
 - parallel
```
public static  Choices parallel(Collection<? extends Predicate<? super I>> criteria)
```
 Retrieves a new instance consisting of a combination of boolean criteria.
 See parallel(Predicate[]) for more details.
 
 Parameters:
 
 criteria - CAUTION: be careful with Collections other than Lists: The effective number and order of elements will be significant!
 - apply
```
public abstract int apply(I input)
```
 Returns an int value representing the combined results of the associated boolean criteria.
 The kind of combination and the result range depends on how this Choices were created.
 
 See Also:
 
 serial(Predicate[]), serial(Collection), parallel(Predicate[]), parallel(Collection)
 - andThen
```
public final <R> Function<I,R> andThen(IntFunction<? extends R> function)
```
 Returns a Function that maps an input of type  to a result of type <R> based on this Choices and a given function that maps an int to a result of type <R>.
 - replying
```
@SafeVarargs
public final <R> Function<I,R> replying(R... results)
```
 Returns a Function that maps an input of type  to one of the given results of type <R>.
 The number of results should equal the number of possible results when evaluating an input. The latter depends on how this Choices were created.
 
 See Also:
 
 serial(Predicate[]), serial(Collection), parallel(Predicate[]), parallel(Collection)
 - replying
```
public final <R> Function<I,R> replying(Collection<? extends R> results)
```
 Returns a Function that maps an input of type  to one of the given results of type <R>.
 The number of results should equal the number of possible results when evaluating an input. The latter depends on how this Choices were created.
 
 Parameters:
 
 results - CAUTION: be careful with Collections other than Lists: The effective number and order of elements will be significant!
 
 See Also:
 
 serial(Predicate[]), serial(Collection), parallel(Predicate[]), parallel(Collection)
 - applying
```
@SafeVarargs
public final <R> Function<I,R> applying(Function<? super I,? extends R>... methods)
```
 Returns a Function that maps an input of type  to one of the given methods to finally get a result of type <R>.
 The number of results should equal the number of possible results when evaluating an input. The latter depends on how this Choices were created.
 
 See Also:
 
 serial(Predicate[]), serial(Collection), parallel(Predicate[]), parallel(Collection)
 - applying
```
public final <R> Function<I,R> applying(Collection<? extends Function<? super I,? extends R>> methods)
```
 Returns a Function that maps an input of type  to one of the given methods to finally get a result of type <R>.
 The number of methods should equal the number of possible results when evaluating an input. The latter depends on how this Choices were created.
 
 Parameters:
 
 methods - CAUTION: be careful with Collections other than Lists: The effective number and order of elements will be significant!
 
 See Also:
 
 serial(Predicate[]), serial(Collection), parallel(Predicate[]), parallel(Collection)

Class Choices<I>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Choices

Method Detail

serial

serial

parallel

parallel

apply

andThen

replying

replying

applying

applying