Interface MessagerUtils

  • All Superinterfaces:
    Utils

    public interface MessagerUtils
    extends Utils
    Messager utilities class
    Since:
    1.0.0
    Author:
    Mercy
    See Also:
    Messager
    • Method Summary

      Static Methods 
      Modifier and Type Method Description
      static void printError​(javax.annotation.processing.Messager messager, java.lang.String pattern, java.lang.Object... args)
      Prints an error message using the provided Messager.
      static void printError​(javax.annotation.processing.ProcessingEnvironment processingEnv, java.lang.String pattern, java.lang.Object... args)
      Prints an error message using the ProcessingEnvironment's Messager.
      static void printMandatoryWarning​(javax.annotation.processing.Messager messager, java.lang.String pattern, java.lang.Object... args)
      Prints a mandatory warning message using the provided Messager.
      static void printMandatoryWarning​(javax.annotation.processing.ProcessingEnvironment processingEnv, java.lang.String pattern, java.lang.Object... args)
      Prints a mandatory warning message using the ProcessingEnvironment's Messager.
      static void printMessage​(javax.annotation.processing.Messager messager, javax.tools.Diagnostic.Kind kind, java.lang.String pattern, java.lang.Object... args)
      Prints a message of the specified kind using the provided Messager.
      static void printMessage​(javax.annotation.processing.ProcessingEnvironment processingEnv, javax.tools.Diagnostic.Kind kind, java.lang.String pattern, java.lang.Object... args)
      Prints a message of the specified kind using the ProcessingEnvironment's Messager.
      static void printNote​(javax.annotation.processing.Messager messager, java.lang.String pattern, java.lang.Object... args)
      Prints a note message using the provided Messager.
      static void printNote​(javax.annotation.processing.ProcessingEnvironment processingEnv, java.lang.String pattern, java.lang.Object... args)
      Prints a note message using the ProcessingEnvironment's Messager.
      static void printWarning​(javax.annotation.processing.Messager messager, java.lang.String pattern, java.lang.Object... args)
      Prints a warning message using the provided Messager.
      static void printWarning​(javax.annotation.processing.ProcessingEnvironment processingEnv, java.lang.String pattern, java.lang.Object... args)
      Prints a warning message using the ProcessingEnvironment's Messager.
    • Method Detail

      • printNote

        static void printNote​(javax.annotation.processing.ProcessingEnvironment processingEnv,
                              java.lang.String pattern,
                              java.lang.Object... args)
        Prints a note message using the ProcessingEnvironment's Messager.
        Parameters:
        processingEnv - the processing environment to obtain the messager from
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printNote

        static void printNote​(javax.annotation.processing.Messager messager,
                              java.lang.String pattern,
                              java.lang.Object... args)
        Prints a note message using the provided Messager.
        Parameters:
        messager - the messager to use for printing the message
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printWarning

        static void printWarning​(javax.annotation.processing.ProcessingEnvironment processingEnv,
                                 java.lang.String pattern,
                                 java.lang.Object... args)
        Prints a warning message using the ProcessingEnvironment's Messager.
        Parameters:
        processingEnv - the processing environment to obtain the messager from
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printWarning

        static void printWarning​(javax.annotation.processing.Messager messager,
                                 java.lang.String pattern,
                                 java.lang.Object... args)
        Prints a warning message using the provided Messager.
        Parameters:
        messager - the messager to use for printing the message
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printMandatoryWarning

        static void printMandatoryWarning​(javax.annotation.processing.ProcessingEnvironment processingEnv,
                                          java.lang.String pattern,
                                          java.lang.Object... args)
        Prints a mandatory warning message using the ProcessingEnvironment's Messager.
        Parameters:
        processingEnv - the processing environment to obtain the messager from
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printMandatoryWarning

        static void printMandatoryWarning​(javax.annotation.processing.Messager messager,
                                          java.lang.String pattern,
                                          java.lang.Object... args)
        Prints a mandatory warning message using the provided Messager.
        Parameters:
        messager - the messager to use for printing the message
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printError

        static void printError​(javax.annotation.processing.ProcessingEnvironment processingEnv,
                               java.lang.String pattern,
                               java.lang.Object... args)
        Prints an error message using the ProcessingEnvironment's Messager.
        Parameters:
        processingEnv - the processing environment to obtain the messager from
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printError

        static void printError​(javax.annotation.processing.Messager messager,
                               java.lang.String pattern,
                               java.lang.Object... args)
        Prints an error message using the provided Messager.
        Parameters:
        messager - the messager to use for printing the message
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printMessage

        static void printMessage​(javax.annotation.processing.ProcessingEnvironment processingEnv,
                                 javax.tools.Diagnostic.Kind kind,
                                 java.lang.String pattern,
                                 java.lang.Object... args)
        Prints a message of the specified kind using the ProcessingEnvironment's Messager.
        Parameters:
        processingEnv - the processing environment to obtain the messager from
        kind - the kind of message to print (e.g., error, warning, note)
        pattern - the message pattern to format
        args - the arguments for the message pattern
      • printMessage

        static void printMessage​(javax.annotation.processing.Messager messager,
                                 javax.tools.Diagnostic.Kind kind,
                                 java.lang.String pattern,
                                 java.lang.Object... args)
        Prints a message of the specified kind using the provided Messager.
        Parameters:
        messager - the messager to use for printing the message
        kind - the kind of message to print (e.g., error, warning, note)
        pattern - the message pattern to format
        args - the arguments for the message pattern