Class MessageInterfaceFactory.AptMessageInterface

    • Field Detail

      • interfaceElement

        private final javax.lang.model.element.TypeElement interfaceElement
      • extendedInterfaces

        private final java.util.Set<MessageInterface> extendedInterfaces
      • messageMethods

        private final java.util.List<MessageMethod> messageMethods
      • validIdRanges

        private final java.util.List<ValidIdRange> validIdRanges
      • expressionProperties

        private final java.util.Properties expressionProperties
      • generatedAnnotation

        private final javax.lang.model.element.TypeElement generatedAnnotation
      • projectCode

        private java.lang.String projectCode
      • packageName

        private java.lang.String packageName
      • simpleName

        private java.lang.String simpleName
      • qualifiedName

        private java.lang.String qualifiedName
      • fqcn

        private java.lang.String fqcn
      • idLen

        private int idLen
    • Constructor Detail

      • AptMessageInterface

        private AptMessageInterface​(javax.lang.model.element.TypeElement interfaceElement,
                                    javax.annotation.processing.ProcessingEnvironment processingEnv,
                                    java.util.Properties expressionProperties,
                                    boolean addGeneratedAnnotation)
    • Method Detail

      • extendsLoggerInterface

        public boolean extendsLoggerInterface()
        Description copied from interface: MessageInterface
        Checks the interface to see if the logger interface is being extended in this interface.
        Specified by:
        extendsLoggerInterface in interface MessageInterface
        Returns:
        true if this interface extends the logger interface, otherwise false.
      • name

        public java.lang.String name()
        Description copied from interface: MessageInterface
        The qualified name of the message interface.
        Specified by:
        name in interface MessageInterface
        Returns:
        the qualified name.
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface javax.lang.model.element.Element
        Overrides:
        hashCode in class java.lang.Object
      • methods

        public java.util.Collection<MessageMethod> methods()
        Description copied from interface: MessageInterface
        A collection of all the methods this interface needs to implement.
        Specified by:
        methods in interface MessageInterface
        Returns:
        a collection of methods.
      • init

        private void init()
      • packageName

        public java.lang.String packageName()
        Description copied from interface: MessageInterface
        The package name of the message interface.
        Specified by:
        packageName in interface MessageInterface
        Returns:
        the package name.
      • getComment

        public java.lang.String getComment()
        Description copied from interface: JavaDocComment
        The JavaDoc comments if available or null if there are no JavaDoc's present.
        Specified by:
        getComment in interface JavaDocComment
        Returns:
        the JavaDoc comments or null.
      • simpleName

        public java.lang.String simpleName()
        Description copied from interface: MessageInterface
        The name of the interface without the package.
        Specified by:
        simpleName in interface MessageInterface
        Returns:
        the simple interface name.
      • loggingFQCN

        public java.lang.String loggingFQCN()
        Description copied from interface: MessageInterface
        The fully qualified class name to use for log methods. This will generally be the same result as MessageInterface.name().
        Specified by:
        loggingFQCN in interface MessageInterface
        Returns:
        the fully qualified class name to use for logging.
      • getIdLength

        public int getIdLength()
        Description copied from interface: MessageInterface
        The length to pad the id with. A value of less than 0 indicates no padding.
        Specified by:
        getIdLength in interface MessageInterface
        Returns:
        the length to pad the id with
      • generatedAnnotation

        public javax.lang.model.element.TypeElement generatedAnnotation()
        Description copied from interface: MessageInterface
        Returns the type to use for the @Generated annotation. This may return null of the implementation should not be annotated.
        Specified by:
        generatedAnnotation in interface MessageInterface
        Returns:
        the type for the generated annotation or null if no annotation is wanted
      • expressionProperties

        public java.util.Properties expressionProperties()
        Description copied from interface: MessageInterface
        The properties used to resolve expressions.
        Specified by:
        expressionProperties in interface MessageInterface
        Returns:
        the properties used to resolve expressions
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface javax.lang.model.element.Element
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object