Package com.mrivanplays.annotationconfig.core.resolver

Enum CommentPlaceholderRegistry

java.lang.Object

java.lang.Enum<CommentPlaceholderRegistry>

com.mrivanplays.annotationconfig.core.resolver.CommentPlaceholderRegistry

All Implemented Interfaces:

Serializable, Comparable<CommentPlaceholderRegistry>, java.lang.constant.Constable

public enum CommentPlaceholderRegistry
extends Enum<CommentPlaceholderRegistry>

Represents a registry for placeholders for comments content. These are applied before the comments are pushed to the ValueWriter.

Since:

3.0.1

Author:

MrIvanPlays

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
INSTANCE

Method Summary

Modifier and Type	Method	Description
List<String>	applyPlaceholders(List<String> comments)	Returns a mutable LinkedList copy of the inputted comments with all the registered placeholders applied.
void	registerPlaceholder(String toReplace, String replacement)	Register a placeholder.
static CommentPlaceholderRegistry	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommentPlaceholderRegistry[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final CommentPlaceholderRegistry INSTANCE

Method Details

values

public static CommentPlaceholderRegistry[] values()

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

Returns:

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

valueOf

public static CommentPlaceholderRegistry 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

registerPlaceholder

public void registerPlaceholder(String toReplace,
 String replacement)

Register a placeholder.

Parameters:

toReplace - value to replace

replacement - replacement value

applyPlaceholders

public List<String> applyPlaceholders(List<String> comments)

Returns a mutable LinkedList copy of the inputted comments with all the registered placeholders applied.

Parameters:

comments - comments to apply placeholders to

Returns:

comments with applied placeholders