org.jrebirth.af.core.resource.i18n

Interface MessageItemReal

All Superinterfaces:

MessageItem, ResourceItem<MessageItem,MessageParams,MessageResource>

All Known Subinterfaces:

MessageEnum, MessageItemReal.Log, MessageItemReal.Msg

All Known Implementing Classes:

MessageItemBase

public interface MessageItemReal
extends MessageItem

The class MessageItem used to declare Message Resource. The key of the i18n message. The name will be transformed : camelCase => CAMEL_CASE

Author:

Sébastien Bordes

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageItemReal.Log The interface Log used to declare Message Resource fro logging.
static interface	MessageItemReal.Msg The interface Msg used to declare Message Resource.

Method Summary

Modifier and Type	Method and Description
default ResourceBuilder<MessageItem,MessageParams,MessageResource>	builder() Return the resource builder.
void	define(MessageResource forcedValue) Define a new forced string.
default MessageResource	get() Return the resource unique instance.
JRLevel	getLevel() Return the optional log level if any.
org.slf4j.Marker	getMarker() Return the optional log marker if any.
String	getText(Object... stringParameters) Get the message formatted text with or without parameterized objects.
void	persist() Persist a message value.
default MessageItem	set(MessageParams messageParams) Attach the resource parameter.

Method Detail

getText

String getText(Object... stringParameters)

Get the message formatted text with or without parameterized objects.

Specified by:

getText in interface MessageItem

Parameters:

stringParameters - the list of object used as string parameter

Returns:

Returns right message formatted with given parameters.

getMarker

org.slf4j.Marker getMarker()

Return the optional log marker if any.

Specified by:

getMarker in interface MessageItem

Returns:

the optional log marker or the Empty one

getLevel

JRLevel getLevel()

Return the optional log level if any.

Specified by:

getLevel in interface MessageItem

Returns:

the optional log level or the info one

define

void define(MessageResource forcedValue)

Define a new forced string. This forced value will be used instead of default programmatic one and all other retrieved from properties files.

Specified by:

define in interface MessageItem

Parameters:

forcedValue - the new string for this message

persist

void persist()

Persist a message value.

Specified by:

persist in interface MessageItem

set

default MessageItem set(MessageParams messageParams)

Attach the resource parameter.

Specified by:

set in interface ResourceItem<MessageItem,MessageParams,MessageResource>

Parameters:

messageParams - the primitive values for this resource

Returns:

the current item to chain method call

get

default MessageResource get()

Return the resource unique instance.

Specified by:

get in interface ResourceItem<MessageItem,MessageParams,MessageResource>

Returns:

the resource

builder

default ResourceBuilder<MessageItem,MessageParams,MessageResource> builder()

Return the resource builder.

Specified by:

builder in interface ResourceItem<MessageItem,MessageParams,MessageResource>

Returns:

the resource builder