Package org.apache.maven.plugins.javadoc

Class AbstractFixJavadocMojo.JavaEntityTags

  • Enclosing class:
    AbstractFixJavadocMojo
    class AbstractFixJavadocMojo.JavaEntityTags
extends java.lang.Object
    Wrapper class for the entity's tags.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Set<java.lang.String> documentedParams  
      private com.thoughtworks.qdox.model.JavaAnnotatedElement entity  
      private boolean isJavaMethod  
      private java.util.List<java.lang.String> namesTags
      List of tag names.
      private java.util.Map<java.lang.String,​java.lang.String> tagParams
      Map with java parameter as key and original Javadoc lines as values.
      private java.lang.String tagReturn
      Original javadoc lines.
      private java.util.Map<java.lang.String,​java.lang.String> tagThrows
      Map with java throw as key and original Javadoc lines as values.
      private java.util.List<java.lang.String> unknownsTags
      Original javadoc lines for unknown tags.

    • Constructor Summary

      Constructors 
      Constructor Description
      JavaEntityTags​(com.thoughtworks.qdox.model.JavaAnnotatedElement entity, boolean isJavaMethod)  

    • Field Detail

      • entity

        private final com.thoughtworks.qdox.model.JavaAnnotatedElement entity

      • isJavaMethod

        private final boolean isJavaMethod

      • namesTags

        private java.util.List<java.lang.String> namesTags
        List of tag names.

      • tagParams

        private java.util.Map<java.lang.String,​java.lang.String> tagParams
        Map with java parameter as key and original Javadoc lines as values.

      • documentedParams

        private java.util.Set<java.lang.String> documentedParams

      • tagReturn

        private java.lang.String tagReturn
        Original javadoc lines.

      • tagThrows

        private java.util.Map<java.lang.String,​java.lang.String> tagThrows
        Map with java throw as key and original Javadoc lines as values.

      • unknownsTags

        private java.util.List<java.lang.String> unknownsTags
        Original javadoc lines for unknown tags.

    • Constructor Detail

      • JavaEntityTags

        JavaEntityTags​(com.thoughtworks.qdox.model.JavaAnnotatedElement entity,
               boolean isJavaMethod)

    • Method Detail

      • getNamesTags

        public java.util.List<java.lang.String> getNamesTags()

      • getJavadocReturnTag

        public java.lang.String getJavadocReturnTag()

      • setJavadocReturnTag

        public void setJavadocReturnTag​(java.lang.String s)

      • getUnknownTags

        public java.util.List<java.lang.String> getUnknownTags()

      • putJavadocParamTag

        public void putJavadocParamTag​(java.lang.String paramName,
                               java.lang.String paramValue,
                               java.lang.String originalJavadocTag)

      • getJavadocParamTag

        public java.lang.String getJavadocParamTag​(java.lang.String paramValue)

      • hasJavadocParamTag

        public boolean hasJavadocParamTag​(java.lang.String paramName)

      • putJavadocThrowsTag

        public void putJavadocThrowsTag​(java.lang.String paramName,
                                java.lang.String originalJavadocTag)

      • getJavadocThrowsTag

        public java.lang.String getJavadocThrowsTag​(java.lang.String paramName)

      • getJavadocThrowsTag

        public java.lang.String getJavadocThrowsTag​(java.lang.String paramName,
                                            boolean nullable)

      • getMessage

        private java.lang.String getMessage​(java.lang.String paramName,
                                    java.lang.String mapName)

      • toString

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