Interface MessageSource

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  MessageSource.MessageContext
      The context to use.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static MessageSource EMPTY
      An empty message source.
      • Fields inherited from interface io.micronaut.core.order.Ordered

        HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method 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.
      default java.lang.String getMessage​(java.lang.String code, java.lang.String defaultMessage, java.util.Locale locale)
      Resolve a message for the given code and context.
      default java.lang.String getMessage​(java.lang.String code, java.lang.String defaultMessage, java.util.Locale locale, java.lang.Object... variables)
      Resolve a message for the given code and context.
      default java.lang.String getMessage​(java.lang.String code, java.lang.String defaultMessage, java.util.Locale locale, java.util.Map<java.lang.String,​java.lang.Object> variables)
      Resolve a message for the given code and context.
      default java.util.Optional<java.lang.String> getMessage​(java.lang.String code, java.util.Locale locale)
      Resolve a message for the given code and context.
      default java.util.Optional<java.lang.String> getMessage​(java.lang.String code, java.util.Locale locale, java.lang.Object... variables)
      Resolve a message for the given code and context.
      default java.util.Optional<java.lang.String> getMessage​(java.lang.String code, java.util.Locale locale, java.util.Map<java.lang.String,​java.lang.Object> variables)
      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.
      • Methods inherited from interface io.micronaut.core.order.Ordered

        getOrder
    • 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
                                                                java.util.Locale locale)
        Resolve a message for the given code and context.
        Parameters:
        code - The code
        locale - The locale to use to resolve messages.
        Returns:
        A message if present
      • getMessage

        @NonNull
        default java.util.Optional<java.lang.String> getMessage​(@NonNull
                                                                java.lang.String code,
                                                                @NonNull
                                                                java.util.Locale locale,
                                                                @NonNull
                                                                java.lang.Object... variables)
        Resolve a message for the given code and context.
        Parameters:
        code - The code
        locale - The locale to use to resolve messages.
        variables - The variables to use resolve message placeholders
        Returns:
        A message if present
      • getMessage

        @NonNull
        default java.util.Optional<java.lang.String> getMessage​(@NonNull
                                                                java.lang.String code,
                                                                @NonNull
                                                                java.util.Locale locale,
                                                                @NonNull
                                                                java.util.Map<java.lang.String,​java.lang.Object> variables)
        Resolve a message for the given code and context.
        Parameters:
        code - The code
        locale - The locale to use to resolve messages.
        variables - The variables to use resolve message placeholders
        Returns:
        A message if present
      • 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
                                            java.lang.String defaultMessage,
                                            @NonNull
                                            java.util.Locale locale)
        Resolve a message for the given code and context.
        Parameters:
        code - The code
        defaultMessage - The default message to use if no other message is found
        locale - The locale to use to resolve messages.
        Returns:
        A message if present
      • getMessage

        @NonNull
        default java.lang.String getMessage​(@NonNull
                                            java.lang.String code,
                                            @NonNull
                                            java.lang.String defaultMessage,
                                            @NonNull
                                            java.util.Locale locale,
                                            @NonNull
                                            java.util.Map<java.lang.String,​java.lang.Object> variables)
        Resolve a message for the given code and context.
        Parameters:
        code - The code
        defaultMessage - The default message to use if no other message is found
        locale - The locale to use to resolve messages.
        variables - The variables to use resolve message placeholders
        Returns:
        A message if present
      • getMessage

        @NonNull
        default java.lang.String getMessage​(@NonNull
                                            java.lang.String code,
                                            @NonNull
                                            java.lang.String defaultMessage,
                                            @NonNull
                                            java.util.Locale locale,
                                            @NonNull
                                            java.lang.Object... variables)
        Resolve a message for the given code and context.
        Parameters:
        code - The code
        defaultMessage - The default message to use if no other message is found
        locale - The locale to use to resolve messages.
        variables - The variables to use resolve message placeholders
        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