程序包 cc.carm.lib.configuration.value.text.function

类 ContentHandler<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

java.lang.Object

cc.carm.lib.configuration.value.text.function.ContentHandler<RECEIVER,SELF>

所有已实现的接口:

Insertable<RECEIVER,SELF>, Replaceable<RECEIVER,SELF>

直接已知子类:

TextParser

public abstract class ContentHandler<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>
extends Object
implements Replaceable<RECEIVER,SELF>, Insertable<RECEIVER,SELF>

字段概要

字段

修饰符和类型	字段	说明
protected boolean	disableInsertion
protected @NotNull List<ContentInserter<RECEIVER>>	inserters
protected final @NotNull Map<String,@Nullable Function<RECEIVER,List<String>>>	insertion	Used to store the insertion of the message
protected String	lineSeparator
protected @NotNull ParamReplacer<RECEIVER>	paramReplacer	Used to store the placeholders of the message
protected @NotNull String[]	params
protected BiFunction<RECEIVER,String,String>	parser
protected @NotNull List<ContentReplacer<RECEIVER>>	replacers

构造器概要

构造器

构造器	说明
ContentHandler()

方法概要

修饰符和类型	方法	说明
static Map<String,Object>	buildParams(@NotNull UnaryOperator<String> paramBuilder, @Nullable String[] params, @Nullable Object[] values)
SELF	disableInsertion()	Disable the insertion of the text.
SELF	enableInsertion()	Enable the insertion of the text.
@Nullable List<String>	getInsertion(@NotNull String id, RECEIVER receiver)
void	handle(@NotNull TextContents contents, RECEIVER receiver, @NotNull Consumer<String> lineConsumer)
SELF	insert(@NotNull String id, @Nullable Function<RECEIVER,List<String>> supplier)	Insert the specific contents by the id.
SELF	inserter(@NotNull ContentInserter<RECEIVER> inserter)
List<ContentInserter<RECEIVER>>	inserters()
boolean	inserting(@NotNull String id)
SELF	lineSeparator(@NotNull String lineSeparator)	Set the line separator for the text.
boolean	noneInsertion()
SELF	paramReplacer(@NotNull ParamReplacer<RECEIVER> paramReplacer)
SELF	params(@NotNull String... params)	Set the params for the text, used for placeholders(Object...) to build the placeholders.
protected @Nullable String	parse(RECEIVER receiver, @NotNull String text)	Parse the supplied single text for the receiver.
SELF	parser(@NotNull BiFunction<RECEIVER,String,String> parser)	Set the parser for the text.
SELF	placeholder(@NotNull String key, @Nullable Object value)	Set the placeholder for the text.
SELF	placeholders(@NotNull Consumer<Map<String,Object>> consumer)	Set the placeholders for the text.
SELF	placeholders(@NotNull Map<String,Object> placeholders)	Set all the placeholders for the text.
SELF	placeholders(@Nullable Object... values)	Set the placeholders for the text.
SELF	removeInsert(@NotNull String id)
SELF	replacer(@NotNull ContentReplacer<RECEIVER> replacer)
List<ContentReplacer<RECEIVER>>	replacers()
abstract SELF	self()
static String	setPlaceholders(@NotNull String messages, @NotNull Map<String,Object> placeholders)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 cc.carm.lib.configuration.value.text.function.inserter.Insertable

insert, insert, insert

从接口继承的方法 cc.carm.lib.configuration.value.text.function.replacer.Replaceable

applyReplacements, replace, replace, replace, replace, replace, replace, replace, replacer

字段详细资料

parser

protected BiFunction<RECEIVER,String,String> parser

lineSeparator

protected String lineSeparator

paramReplacer

@NotNull
protected @NotNull ParamReplacer<RECEIVER> paramReplacer

Used to store the placeholders of the message

params

@NotNull
protected @NotNull String[] params

replacers

@NotNull
protected @NotNull List<ContentReplacer<RECEIVER>> replacers

inserters

@NotNull
protected @NotNull List<ContentInserter<RECEIVER>> inserters

insertion

@NotNull
protected final @NotNull Map<String,@Nullable Function<RECEIVER,List<String>>> insertion

Used to store the insertion of the message

disableInsertion

protected boolean disableInsertion

构造器详细资料

ContentHandler

public ContentHandler()

方法详细资料

self

public abstract SELF self()

disableInsertion

public SELF disableInsertion()

Disable the insertion of the text.
If the insertion is disabled, the text will be parsed directly.

返回:

the current ContentHandler instance

enableInsertion

public SELF enableInsertion()

Enable the insertion of the text.

返回:

the current ContentHandler instance

noneInsertion

public boolean noneInsertion()

指定者:

noneInsertion 在接口中 Insertable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

lineSeparator

public SELF lineSeparator(@NotNull
 @NotNull String lineSeparator)

Set the line separator for the text.

参数:

lineSeparator - the line separator, default is System.lineSeparator()

返回:

the current ContentHandler instance

placeholders

public SELF placeholders(@NotNull
 @NotNull Map<String,Object> placeholders)

Set all the placeholders for the text.
Will override the previous placeholders modifications.

参数:

placeholders - the placeholders

返回:

the current ContentHandler instance

placeholders

public SELF placeholders(@NotNull
 @NotNull Consumer<Map<String,Object>> consumer)

Set the placeholders for the text.

参数:

consumer - the placeholders

返回:

the current ContentHandler instance

placeholders

public SELF placeholders(@Nullable
 @Nullable Object... values)

Set the placeholders for the text.

参数:

values - The values to replace the params(String...).

返回:

the current ContentHandler instance

placeholder

public SELF placeholder(@NotNull
 @NotNull String key,
 @Nullable
 @Nullable Object value)

Set the placeholder for the text.

参数:

key - the key of the placeholder

value - the value of the placeholder

返回:

the current ContentHandler instance

params

public SELF params(@NotNull
 @NotNull String... params)

Set the params for the text, used for placeholders(Object...) to build the placeholders.

参数:

params - the params

返回:

the current ContentHandler instance

replacers

public List<ContentReplacer<RECEIVER>> replacers()

指定者:

replacers 在接口中 Replaceable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

replacer

public SELF replacer(@NotNull
 @NotNull ContentReplacer<RECEIVER> replacer)

指定者:

replacer 在接口中 Replaceable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

paramReplacer

public SELF paramReplacer(@NotNull
 @NotNull ParamReplacer<RECEIVER> paramReplacer)

inserters

public List<ContentInserter<RECEIVER>> inserters()

指定者:

inserters 在接口中 Insertable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

inserter

public SELF inserter(@NotNull
 @NotNull ContentInserter<RECEIVER> inserter)

指定者:

inserter 在接口中 Insertable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

insert

public SELF insert(@NotNull
 @NotNull String id,
 @Nullable
 @Nullable Function<RECEIVER,List<String>> supplier)

从接口复制的说明: Insertable

Insert the specific contents by the id.

指定者:

insert 在接口中 Insertable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

参数:

id - the id of the insertion text

supplier - to supply the lines to insert

返回:

the current ContentHandler instance

inserting

public boolean inserting(@NotNull
 @NotNull String id)

指定者:

inserting 在接口中 Insertable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

getInsertion

@Nullable
public @Nullable List<String> getInsertion(@NotNull
 @NotNull String id,
 @Nullable
 RECEIVER receiver)

指定者:

getInsertion 在接口中 Insertable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

removeInsert

public SELF removeInsert(@NotNull
 @NotNull String id)

指定者:

removeInsert 在接口中 Insertable<RECEIVER,SELF extends ContentHandler<RECEIVER,SELF>>

parser

public SELF parser(@NotNull
 @NotNull BiFunction<RECEIVER,String,String> parser)

Set the parser for the text.

参数:

parser - The parser

返回:

The current ContentHandler instance

parse

@Nullable
protected @Nullable String parse(@Nullable
 RECEIVER receiver,
 @NotNull
 @NotNull String text)

Parse the supplied single text for the receiver.

参数:

receiver - the receiver

text - the text to parse

返回:

the parsed text

handle

public void handle(@NotNull
 @NotNull TextContents contents,
 @Nullable
 RECEIVER receiver,
 @NotNull
 @NotNull Consumer<String> lineConsumer)

setPlaceholders

public static String setPlaceholders(@NotNull
 @NotNull String messages,
 @NotNull
 @NotNull Map<String,Object> placeholders)

buildParams

public static Map<String,Object> buildParams(@NotNull
 @NotNull UnaryOperator<String> paramBuilder,
 @Nullable
 @Nullable String[] params,
 @Nullable
 @Nullable Object[] values)