de.caff.templ

Enum MultiDecoration

java.lang.Object

java.lang.Enum<MultiDecoration>

de.caff.templ.MultiDecoration

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MultiDecoration>

public enum MultiDecoration
extends java.lang.Enum<MultiDecoration>

Possible decorations for multiple insertions.

Since:

April 06, 2026

Author:

Rammi

Enum Constant Summary

Enum Constants

Enum Constant and Description
Prefix Prefix decoration.
Separator Separator decoration.
Suffix Suffix decoration.

Field Summary

Fields

Modifier and Type	Field and Description
char	marker The marker for the decoration type.
java.lang.String	markerAsText The marker for the decoration type, as text.
static Indexable<MultiDecoration>	VALUES The values of this enum.

Method Summary

Modifier and Type	Method and Description
static MultiDecoration	fromInternal(int internalValue) Get the DecoType enum associated with the given internal value.
static MultiDecoration	fromInternal(int internalValue, MultiDecoration defaultValue) Get the DecoType enum associated with the given internal value.
static MultiDecoration	fromMarker(char marker) Resolve the decoration type from its marker.
static MultiDecoration	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MultiDecoration[]	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

Enum Constant Detail

Prefix

public static final MultiDecoration Prefix

Prefix decoration.

The prefix decoration is inserted before the repeated multiple insertion if there is at least one insertion.

Separator

public static final MultiDecoration Separator

Separator decoration.

The separator is inserted between multiple insertions. So it requires at least two insertions to become visible.

Suffix

public static final MultiDecoration Suffix

Suffix decoration.

The suffix decoration is inserted after the repeated multiple insertion if there is at least one insertion.

Field Detail

marker

public final char marker

The marker for the decoration type.

markerAsText

@NotNull
public final java.lang.String markerAsText

The marker for the decoration type, as text.

VALUES

@NotNull
public static final Indexable<MultiDecoration> VALUES

The values of this enum. Use this instead of values() because it does not require internal array copying.

Method Detail

values

public static MultiDecoration[] 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 (MultiDecoration c : MultiDecoration.values())
    System.out.println(c);

Returns:

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

valueOf

public static MultiDecoration valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

fromInternal

@Nullable
public static MultiDecoration fromInternal(int internalValue)

Get the DecoType enum associated with the given internal value.

Parameters:

internalValue - internal value

Returns:

associated enum value, or null if there is none

fromInternal

@NotNull
public static MultiDecoration fromInternal(int internalValue,
                                                    @NotNull
                                                    MultiDecoration defaultValue)

Get the DecoType enum associated with the given internal value.

Parameters:

internalValue - internal value

defaultValue - default value

Returns:

associated enum value, or defaultValue if there is none

fromMarker

@Nullable
public static MultiDecoration fromMarker(char marker)

Resolve the decoration type from its marker.

Parameters:

marker - given marker

Returns:

the decoration type associated with the given marker, or null