Module org.jooq.meta
Package org.jooq.meta.jaxb

Class CommentType

java.lang.Object
org.jooq.meta.jaxb.CommentType
All Implemented Interfaces:
Serializable, XMLAppendable
public class CommentType extends Object implements Serializable, XMLAppendable
The documentation configuration.

This feature is available in the commercial distribution only.

See Also:

  • Field Details

    • expression

      protected String expression

    • message

      protected String message

    • deprecated

      protected Boolean deprecated

    • includeSchemaComment

      protected Boolean includeSchemaComment

    • ignoreUnused

      protected Boolean ignoreUnused

  • Constructor Details

    • CommentType

      public CommentType()

  • Method Details

    • getExpression

      public String getExpression()
      A regular expression matching all objects that should be commented.

    • setExpression

      public void setExpression(String value)
      A regular expression matching all objects that should be commented.

    • getMessage

      public String getMessage()
      A comment that should be added to objects matched by this configuration.

    • setMessage

      public void setMessage(String value)
      A comment that should be added to objects matched by this configuration.

    • isDeprecated

      public Boolean isDeprecated()
      Whether the comment is a deprecation notice.
      Returns:
      possible object is Boolean

    • setDeprecated

      public void setDeprecated(Boolean value)
      Whether the comment is a deprecation notice.
      Parameters:
      value - allowed object is Boolean

    • isIncludeSchemaComment

      public Boolean isIncludeSchemaComment()
      Whether the schema comment (if available) should be included and prepended to the message.
      Returns:
      possible object is Boolean

    • setIncludeSchemaComment

      public void setIncludeSchemaComment(Boolean value)
      Whether the schema comment (if available) should be included and prepended to the message.
      Parameters:
      value - allowed object is Boolean

    • isIgnoreUnused

      public Boolean isIgnoreUnused()
      Set this flag to true if no warning should be logged if this object was not used by a code generation run.
      Returns:
      possible object is Boolean

    • setIgnoreUnused

      public void setIgnoreUnused(Boolean value)
      Set this flag to true if no warning should be logged if this object was not used by a code generation run.
      Parameters:
      value - allowed object is Boolean

    • withExpression

      public CommentType withExpression(String value)
      A regular expression matching all objects that should be commented.

    • withMessage

      public CommentType withMessage(String value)
      A comment that should be added to objects matched by this configuration.

    • withDeprecated

      public CommentType withDeprecated(Boolean value)
      Whether the comment is a deprecation notice.

    • withIncludeSchemaComment

      public CommentType withIncludeSchemaComment(Boolean value)
      Whether the schema comment (if available) should be included and prepended to the message.

    • withIgnoreUnused

      public CommentType withIgnoreUnused(Boolean value)
      Set this flag to true if no warning should be logged if this object was not used by a code generation run.

    • appendTo

      public final void appendTo(XMLBuilder builder)
      Specified by:
      appendTo in interface XMLAppendable

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object that)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object