org.ujorm.tools.msg

Class MessageArg<T>

java.lang.Object

org.ujorm.tools.msg.MessageArg<T>

Type Parameters:

T - The parameter has only a descriptive meaning with no functionality.

All Implemented Interfaces:

Serializable, CharSequence

public final class MessageArg<T>
extends Object
implements Serializable, CharSequence

Message Argument

Since:

1.54

Author:

Pavel Ponec

See Also:

MessageService, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_BEG Two-character mark ("${") to introducing a template argument.
static char	PARAM_END The mark ("}") to finishing a template argument.

Constructor Summary

Constructors

Constructor and Description
MessageArg(@NotNull String name) Name constructor
MessageArg(@NotNull String name, @Nullable String format) Common constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
@NotNull String	getCode() A code name for a template
@Nullable String	getFormat() Get optional format of the argument
@NotNull String	getName() Get Name of argument
<T> T	getValue(Map<String,Object> map) Get a value from a map
char	charAt(int index)
int	length()
@NotNull String	name() An alias for method #getName()
static <T> MessageArg<T>	of(@NotNull String name)
static <T> MessageArg<T>	of(@NotNull String name, @Nullable String format)
CharSequence	subSequence(int start, int end)
protected @NotNull String	toCode() Convert attributes to a code
String	toString() Returns a code name

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

codePoints, chars

Field Detail

PARAM_BEG

public static final String PARAM_BEG

Two-character mark ("${") to introducing a template argument.

See Also:

Constant Field Values

PARAM_END

public static final char PARAM_END

The mark ("}") to finishing a template argument.

See Also:

Constant Field Values

Constructor Detail

MessageArg

public MessageArg(@NotNull
                  @NotNull String name)

Name constructor

MessageArg

public MessageArg(@NotNull
                  @NotNull String name,
                  @Nullable
                  @Nullable String format)

Common constructor

Parameters:

name - Argument name

format - Format syntax is described on java.util.Formatter

Method Detail

getName

@NotNull
public @NotNull String getName()

Get Name of argument

name

@NotNull
public final @NotNull String name()

An alias for method #getName()

getFormat

@Nullable
public @Nullable String getFormat()

Get optional format of the argument

getCode

@NotNull
public @NotNull String getCode()

A code name for a template

toCode

@NotNull
protected final @NotNull String toCode()

Convert attributes to a code

getValue

public <T> T getValue(Map<String,Object> map)

Get a value from a map

toString

public final String toString()

Returns a code name

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

length

public final int length()

Specified by:

length in interface CharSequence

charAt

public final char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public final CharSequence subSequence(int start,
                                      int end)

Specified by:

subSequence in interface CharSequence

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

of

public static <T> MessageArg<T> of(@NotNull
                                   @NotNull String name)

of

public static <T> MessageArg<T> of(@NotNull
                                   @NotNull String name,
                                   @Nullable
                                   @Nullable String format)