Package org.jboss.logging.processor.model

Interface MessageMethod

    • Method Detail

      • name

        java.lang.String name()
        Returns the method name.
        Returns:
        the method name.

      • parameters

        java.util.Set<Parameter> parameters()
        Returns the parameters for the method.
        Returns:
        the parameters for the method

      • parametersAnnotatedWith

        java.util.Set<Parameter> parametersAnnotatedWith​(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
        Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.
        Parameters:
        annotation - the annotation to get the parameters for
        Returns:
        a collection of the parameters or an empty set.

      • returnType

        ReturnType returnType()
        Returns the return type for the method.
        Returns:
        the return type for the method.

      • thrownTypes

        java.util.Set<ThrowableType> thrownTypes()
        Returns a collection of throwable types the method throws. If the method throws no exceptions an empty collection is returned.
        Returns:
        a collection of throwable types or an empty collection.

      • inheritsMessage

        boolean inheritsMessage()
        Indicates whether the message was inherited from another message or not. If true is returned the MessageMethod.Message was inherited from a different method, otherwise false.

        Note: false does not indicate the method has a Message annotation.

        Returns:
        true if the message was inherited from a different method, otherwise false.

      • messageMethodName

        java.lang.String messageMethodName()
        Returns the name of the method used to retrieve the message.
        Returns:
        the name of the message method.

      • translationKey

        java.lang.String translationKey()
        Returns the name of the key used in the translation files for the message translation.
        Returns:
        the name of the key in the translation files.

      • hasCause

        boolean hasCause()
        Returns true if there is a cause element, otherwise false.
        Returns:
        true if there is a cause element, otherwise false

      • isOverloaded

        boolean isOverloaded()
        Returns true if the method is overloaded, otherwise false .
        Returns:
        true if the method is overloaded, otherwise false

      • cause

        Parameter cause()
        Returns the cause element if hasCause() returns true, otherwise null.
        Returns:
        the cause element, otherwise null.

      • loggerMethod

        java.lang.String loggerMethod()
        Returns the LogMessage annotation associated with this method only if isLoggerMethod() returns true.
        Returns:
        the log message annotation

      • logLevel

        java.lang.String logLevel()
        Returns the log level parameter associated with the method only if isLoggerMethod() returns true.
        Returns:
        the enum name of the log level

      • formatParameterCount

        int formatParameterCount()
        Returns the number of parameters minus the cause parameter count for the method.
        Returns:
        the number of parameters minus the cause parameter count for the method.

      • isLoggerMethod

        boolean isLoggerMethod()
        Returns true if this is a logger method, otherwise false.
        Returns:
        true if this is a logger method, otherwise false.