Package eu.bandm.tools.format

Enum Class CompoundConstructor

java.lang.Object

java.lang.Enum<CompoundConstructor>

eu.bandm.tools.format.CompoundConstructor

All Implemented Interfaces:

Serializable, Comparable<CompoundConstructor>, java.lang.constant.Constable, Function<Collection<Format>,Format>

public enum CompoundConstructor
extends Enum<CompoundConstructor>
implements Function<Collection<Format>,Format>

The different operators which combine multiple sub-formats into one compound format.

See Also:

• for corresponding static factory methods.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
append
beneath
beside
block
line
tabular

Method Summary

Modifier and Type	Method	Description
abstract Format	apply(Collection<Format> subs)	Service point: returns an instance of the correctly chosen sub-class of Format.Compound which corresponds to the combination method represented by the enumeration value.
static CompoundConstructor	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompoundConstructor[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Enum Constant Details

tabular

public static final CompoundConstructor tabular

append

public static final CompoundConstructor append

block

public static final CompoundConstructor block

line

public static final CompoundConstructor line

beside

public static final CompoundConstructor beside

beneath

public static final CompoundConstructor beneath

Method Details

values

public static CompoundConstructor[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CompoundConstructor valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

apply

public abstract Format apply(Collection<Format> subs)

Service point: returns an instance of the correctly chosen sub-class of Format.Compound which corresponds to the combination method represented by the enumeration value. Goes via the factory methods, so it can return a singleton list content or an instance of Empty.

Specified by:

apply in interface Function<Collection<Format>,Format>