Class Messages


  • public final class Messages
    extends java.lang.Object
    Utility methods for Message objects
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Messages()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static java.lang.Object appendModules​(java.lang.Object source, ElementSource elementSource)  
      (package private) static java.lang.Object convert​(java.lang.Object o)
      Formats an object in a user friendly way.
      (package private) static java.lang.Object convert​(java.lang.Object o, ElementSource source)  
      static Message create​(java.lang.String messageFormat, java.lang.Object... arguments)
      Creates a new Message without a cause.
      static Message create​(java.lang.Throwable cause, java.lang.String messageFormat, java.lang.Object... arguments)
      Creates a new Message with the given cause.
      static Message create​(java.lang.Throwable cause, java.util.List<java.lang.Object> sources, java.lang.String messageFormat, java.lang.Object... arguments)
      Creates a new Message with the given cause and a binding source stack.
      static java.lang.String format​(java.lang.String messageFormat, java.lang.Object... arguments)
      Calls String.format(java.lang.String, java.lang.Object...) after converting the arguments using some standard guice formatting for Key, Class and Member objects.
      private static void formatInjectionPoint​(java.util.Formatter formatter, Dependency<?> dependency, InjectionPoint injectionPoint, ElementSource elementSource)  
      static java.lang.String formatMessages​(java.lang.String heading, java.util.Collection<Message> errorMessages)
      Returns the formatted message for an exception with the specified messages.
      (package private) static java.lang.String formatParameter​(Dependency<?> dependency)  
      (package private) static void formatSource​(java.util.Formatter formatter, java.lang.Object source)  
      (package private) static void formatSource​(java.util.Formatter formatter, java.lang.Object source, ElementSource elementSource)  
      static java.lang.Throwable getOnlyCause​(java.util.Collection<Message> messages)
      Returns the cause throwable if there is exactly one cause in messages.
      private static java.lang.String getOrdinalSuffix​(int ordinal)
      Maps 1 to the string "1st" ditto for all non-negative numbers
      (package private) static Message mergeSources​(java.util.List<java.lang.Object> sources, Message message)
      Prepends the list of sources to the given Message
      private static java.lang.String moduleSourceString​(ElementSource elementSource)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

    • Constructor Detail

      • Messages

        private Messages()
    • Method Detail

      • mergeSources

        static Message mergeSources​(java.util.List<java.lang.Object> sources,
                                    Message message)
        Prepends the list of sources to the given Message
      • format

        public static java.lang.String format​(java.lang.String messageFormat,
                                              java.lang.Object... arguments)
        Calls String.format(java.lang.String, java.lang.Object...) after converting the arguments using some standard guice formatting for Key, Class and Member objects.
      • formatMessages

        public static java.lang.String formatMessages​(java.lang.String heading,
                                                      java.util.Collection<Message> errorMessages)
        Returns the formatted message for an exception with the specified messages.
      • create

        public static Message create​(java.lang.String messageFormat,
                                     java.lang.Object... arguments)
        Creates a new Message without a cause.
        Parameters:
        messageFormat - Format string
        arguments - format string arguments
      • create

        public static Message create​(java.lang.Throwable cause,
                                     java.lang.String messageFormat,
                                     java.lang.Object... arguments)
        Creates a new Message with the given cause.
        Parameters:
        cause - The exception that caused the error
        messageFormat - Format string
        arguments - format string arguments
      • create

        public static Message create​(java.lang.Throwable cause,
                                     java.util.List<java.lang.Object> sources,
                                     java.lang.String messageFormat,
                                     java.lang.Object... arguments)
        Creates a new Message with the given cause and a binding source stack.
        Parameters:
        cause - The exception that caused the error
        sources - The binding sources for the source stack
        messageFormat - Format string
        arguments - format string arguments
      • convert

        static java.lang.Object convert​(java.lang.Object o)
        Formats an object in a user friendly way.
      • convert

        static java.lang.Object convert​(java.lang.Object o,
                                        ElementSource source)
      • appendModules

        private static java.lang.Object appendModules​(java.lang.Object source,
                                                      ElementSource elementSource)
      • moduleSourceString

        private static java.lang.String moduleSourceString​(ElementSource elementSource)
      • formatSource

        static void formatSource​(java.util.Formatter formatter,
                                 java.lang.Object source)
      • formatSource

        static void formatSource​(java.util.Formatter formatter,
                                 java.lang.Object source,
                                 ElementSource elementSource)
      • formatInjectionPoint

        private static void formatInjectionPoint​(java.util.Formatter formatter,
                                                 Dependency<?> dependency,
                                                 InjectionPoint injectionPoint,
                                                 ElementSource elementSource)
      • formatParameter

        static java.lang.String formatParameter​(Dependency<?> dependency)
      • getOnlyCause

        public static java.lang.Throwable getOnlyCause​(java.util.Collection<Message> messages)
        Returns the cause throwable if there is exactly one cause in messages. If there are zero or multiple messages with causes, null is returned.