io.micronaut.context

Interface MessageSource

All Known Implementing Classes:

AbstractMessageSource, CompositeMessageSource, DefaultValidationMessages, ResourceBundleMessageSource, StaticMessageSource

@Singleton
 @Indexed(value=MessageSource.class)
public interface MessageSource

Interface for resolving messages from some source.

Since:

1.2

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageSource.MessageContext The context to use.

Field Summary

Fields

Modifier and Type	Field and Description
static MessageSource	EMPTY An empty message source.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getMessage(String code, MessageSource.MessageContext context) Resolve a message for the given code and context.
default String	getMessage(String code, MessageSource.MessageContext context, String defaultMessage) Resolve a message for the given code and context.
default String	getRequiredMessage(String code, MessageSource.MessageContext context) Resolve a message for the given code and context or throw an exception.
String	interpolate(String template, MessageSource.MessageContext context) Interpolate the given message template.

Field Detail

EMPTY

static final MessageSource EMPTY

An empty message source.

Method Detail

getMessage

@Nonnull
Optional<String> getMessage(@Nonnull
                                     String code,
                                     @Nonnull
                                     MessageSource.MessageContext context)

Resolve a message for the given code and context.

Parameters:

code - The code

context - The context

Returns:

A message if present

getMessage

@Nonnull
default String getMessage(@Nonnull
                                   String code,
                                   @Nonnull
                                   MessageSource.MessageContext context,
                                   @Nonnull
                                   String defaultMessage)

Resolve a message for the given code and context.

Parameters:

code - The code

context - The context

defaultMessage - The default message to use if no other message is found

Returns:

A message if present

interpolate

@Nonnull
String interpolate(@Nonnull
                            String template,
                            @Nonnull
                            MessageSource.MessageContext context)

Interpolate the given message template.

Parameters:

template - The template

context - The context to use.

Returns:

The interpolated message.

Throws:

IllegalArgumentException - If any argument specified is null

getRequiredMessage

@Nonnull
default String getRequiredMessage(@Nonnull
                                           String code,
                                           @Nonnull
                                           MessageSource.MessageContext context)

Resolve a message for the given code and context or throw an exception.

Parameters:

code - The code

context - The context

Returns:

The message

Throws:

NoSuchMessageException - if the message is not found