Interface LocalizedMessageSource

  • All Known Implementing Classes:
    AbstractLocalizedMessageSource

    public interface LocalizedMessageSource
    Retrieve messages for the resolved locale.
    Since:
    3.4.0
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> getMessage​(java.lang.String code)
      Resolve a message for the given code.
      java.util.Optional<java.lang.String> getMessage​(java.lang.String code, java.lang.Object... variables)
      Resolve a message for the given code and variables for the messages.
      java.util.Optional<java.lang.String> getMessage​(java.lang.String code, java.util.Map<java.lang.String,​java.lang.Object> variables)
      Resolve a message for the given code and variables for the messages.
      default java.lang.String getMessageOrDefault​(java.lang.String code, java.lang.String defaultMessage)
      Resolve a message for the given code.
      default java.lang.String getMessageOrDefault​(java.lang.String code, java.lang.String defaultMessage, java.lang.Object... variables)
      Resolve a message for the given code.
      default java.lang.String getMessageOrDefault​(java.lang.String code, java.lang.String defaultMessage, java.util.Map<java.lang.String,​java.lang.Object> variables)
      Resolve a message for the given code.
    • Method Detail

      • getMessage

        @NonNull
        java.util.Optional<java.lang.String> getMessage​(@NonNull
                                                        java.lang.String code)
        Resolve a message for the given code.
        Parameters:
        code - The code
        Returns:
        A message if present
      • getMessage

        @NonNull
        java.util.Optional<java.lang.String> getMessage​(@NonNull
                                                        java.lang.String code,
                                                        java.lang.Object... variables)
        Resolve a message for the given code and variables for the messages.
        Parameters:
        code - The code
        variables - to be used to interpolate the message
        Returns:
        A message if present
      • getMessage

        @NonNull
        java.util.Optional<java.lang.String> getMessage​(@NonNull
                                                        java.lang.String code,
                                                        java.util.Map<java.lang.String,​java.lang.Object> variables)
        Resolve a message for the given code and variables for the messages.
        Parameters:
        code - The code
        variables - to be used to interpolate the message
        Returns:
        A message if present
      • getMessageOrDefault

        @NonNull
        default java.lang.String getMessageOrDefault​(@NonNull
                                                     java.lang.String code,
                                                     @NonNull
                                                     java.lang.String defaultMessage)
        Resolve a message for the given code. If the message is not present then default message is returned.
        Parameters:
        code - The code
        defaultMessage - The default message to use if no other message is found
        Returns:
        A message if present. If the message is not present then default message supplied is returned.
      • getMessageOrDefault

        @NonNull
        default java.lang.String getMessageOrDefault​(@NonNull
                                                     java.lang.String code,
                                                     @NonNull
                                                     java.lang.String defaultMessage,
                                                     java.lang.Object... variables)
        Resolve a message for the given code. If the message is not present then default message is returned.
        Parameters:
        code - The code
        defaultMessage - The default message to use if no other message is found
        variables - to be used to interpolate the message
        Returns:
        A message if present. If the message is not present then default message supplied is returned.
      • getMessageOrDefault

        @NonNull
        default java.lang.String getMessageOrDefault​(@NonNull
                                                     java.lang.String code,
                                                     @NonNull
                                                     java.lang.String defaultMessage,
                                                     java.util.Map<java.lang.String,​java.lang.Object> variables)
        Resolve a message for the given code. If the message is not present then default message is returned.
        Parameters:
        code - The code
        defaultMessage - The default message to use if no other message is found
        variables - to be used to interpolate the message
        Returns:
        A message if present. If the message is not present then default message supplied is returned.