kemitix/conditional
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Value: add missing javadoc

Browse source
This commit is contained in:
Paul Campbell 2017-08-26 23:11:10 +01:00
parent a1d9f17faf
commit d9e3401658
1 changed files with 35 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
src/main/java/net/kemitix/conditional/Value.java
View file

@ -31,6 +31,41 @@ import java.util.function.Supplier;
*/
public interface Value {
/**
* Return one of two values depending on the value of a clause.
*
* @param clause The deciding clause
* @param trueSupplier The supplier to provide the value when the clause is true
* @param falseSupplier The supplier to provide the value when the clause is false
* @param <T> The type of the value
*
* @return the value from either the trueSupplier or the falseSupplier
*/
static <T> T where(
boolean clause,
Supplier<T> trueSupplier,
Supplier<T> falseSupplier
) {
return Value.<T>where(clause).then(trueSupplier)
.otherwise(falseSupplier);
}
/**
* Return an Optional either containing a value, if the clause is true, or empty.
*
* @param clause The deciding clause
* @param trueSupplier The supplier to provide the value when the clause is true
* @param <T> The type of the value
*
* @return an Optional either containing the value from the trueSupplier or empty
*/
static <T> Optional<T> where(
boolean clause,
Supplier<T> trueSupplier
) {
return Optional.ofNullable(Value.where(clause, trueSupplier, () -> null));
}
/**
* Create a new {@link ValueClause} for the clause.
*
@ -56,22 +91,6 @@ public interface Value {
return where(!clause);
}
static <T> T where(
boolean clause,
Supplier<T> trueSupplier,
Supplier<T> falseSupplier
) {
return Value.<T>where(clause).then(trueSupplier)
.otherwise(falseSupplier);
}
static <T> Optional<T> where(
boolean clause,
Supplier<T> trueSupplier
) {
return Optional.ofNullable(Value.where(clause, trueSupplier, () -> null));
}
/**
* An intermediate state in determining the final {@link Value}.
*