com.github.dakusui.pcond.forms

Enum Printables

java.lang.Object

java.lang.Enum<Printables>

com.github.dakusui.pcond.forms.Printables

All Implemented Interfaces:

Serializable, Comparable<Printables>

public enum Printables
extends Enum<Printables>

An entry point class that provides methods to create a new "printable" function from a given conventional function.

Method Summary

Modifier and Type	Method and Description
static <T,R> Function<T,R>	function(String name, Function<T,R> function) Returns a printable function for a given one.
static <T,R> Function<T,R>	function(Supplier<String> formatter, Function<T,R> function) Returns a printable function for a given one.
static <T> Predicate<T>	predicate(String name, Predicate<T> predicate) Returns a printable predicate for a given one.
static <T> Predicate<T>	predicate(Supplier<String> formatter, Predicate<T> predicate) Returns a printable predicate for a given one.
static Printables	valueOf(String name) Returns the enum constant of this type with the specified name.
static Printables[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static Printables[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Printables c : Printables.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Printables valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

predicate

public static <T> Predicate<T> predicate(String name,
                                         Predicate<T> predicate)

Returns a printable predicate for a given one. This is a short hand of Printables.predicate(() → name, predicate).

Type Parameters:

T - The type that the returned predicate can test.

Parameters:

name - A name of the returned predicate.

predicate - A predicate from which a printable predicate is created.

Returns:

A printable predicate.

predicate

public static <T> Predicate<T> predicate(Supplier<String> formatter,
                                         Predicate<T> predicate)

Returns a printable predicate for a given one.

Type Parameters:

T - The type that the returned predicate can test.

Parameters:

formatter - A supplier that gives a string printed on toString().

predicate - A predicate from which a printable predicate is created.

Returns:

A printable predicate.

function

public static <T,R> Function<T,R> function(String name,
                                           Function<T,R> function)

Returns a printable function for a given one. This is a short-hand method for Printables.function(() → name, function).

Type Parameters:

T - A type of the function’s parameter.

R - A type of the function’s returned value.

Parameters:

name - A name of the function.

function - A function from which a printable function is created.

Returns:

A printable function.

function

public static <T,R> Function<T,R> function(Supplier<String> formatter,
                                           Function<T,R> function)

Returns a printable function for a given one.

Type Parameters:

T - A type of the function’s parameter.

R - A type of the function’s returned value.

Parameters:

formatter - A supplier that gives a string printed on toString().

function - A function from which a printable function is created.

Returns:

A printable function.