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
default java.util.Optional<java.lang.String>	getMessage(java.lang.String code, MessageSource.MessageContext context) Resolve a message for the given code and context.
default java.lang.String	getMessage(java.lang.String code, MessageSource.MessageContext context, java.lang.String defaultMessage) Resolve a message for the given code and context.
java.util.Optional<java.lang.String>	getRawMessage(java.lang.String code, MessageSource.MessageContext context) Resolve a message for the given code and context.
default java.lang.String	getRawMessage(java.lang.String code, MessageSource.MessageContext context, java.lang.String defaultMessage) Resolve a message for the given code and context.
default java.lang.String	getRequiredMessage(java.lang.String code, MessageSource.MessageContext context) Resolve a message for the given code and context or throw an exception.
default java.lang.String	getRequiredRawMessage(java.lang.String code, MessageSource.MessageContext context) Resolve a message for the given code and context or throw an exception.
java.lang.String	interpolate(java.lang.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
default java.util.Optional<java.lang.String> getMessage(@NonNull
                                                                 java.lang.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 java.lang.String getMessage(@NonNull
                                             java.lang.String code,
                                             @NonNull
                                             MessageSource.MessageContext context,
                                             @NonNull
                                             java.lang.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

getRawMessage

@NonNull
java.util.Optional<java.lang.String> getRawMessage(@NonNull
                                                            java.lang.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

getRawMessage

@NonNull
default java.lang.String getRawMessage(@NonNull
                                                java.lang.String code,
                                                @NonNull
                                                MessageSource.MessageContext context,
                                                @NonNull
                                                java.lang.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
java.lang.String interpolate(@NonNull
                                      java.lang.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:

java.lang.IllegalArgumentException - If any argument specified is null

getRequiredMessage

@NonNull
default java.lang.String getRequiredMessage(@NonNull
                                                     java.lang.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

getRequiredRawMessage

@NonNull
default java.lang.String getRequiredRawMessage(@NonNull
                                                        java.lang.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