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:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Boolean deprecated

protected String expression

protected Boolean includeSchemaComment

protected String message

Constructor Summary

Constructors
Constructor Description

CommentType()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`appendTo(XMLBuilder builder)`
`boolean`	`equals(Object that)`
`String`	`getExpression()`	A regular expression matching all objects that should be commented.
`String`	`getMessage()`	A comment that should be added to objects matched by this configuration.
`int`	`hashCode()`
`Boolean`	`isDeprecated()`	Whether the comment is a deprecation notice.
`Boolean`	`isIncludeSchemaComment()`	Whether the schema comment (if available) should be included and prepended to the message.
`void`	`setDeprecated(Boolean value)`	Sets the value of the deprecated property.
`void`	`setExpression(String value)`	A regular expression matching all objects that should be commented.
`void`	`setIncludeSchemaComment(Boolean value)`	Sets the value of the includeSchemaComment property.
`void`	`setMessage(String value)`	A comment that should be added to objects matched by this configuration.
`String`	`toString()`
`CommentType`	`withDeprecated(Boolean value)`
`CommentType`	`withExpression(String value)`	A regular expression matching all objects that should be commented.
`CommentType`	`withIncludeSchemaComment(Boolean value)`
`CommentType`	`withMessage(String value)`	A comment that should be added to objects matched by this configuration.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - expression
```
protected String expression
```
  - message
```
protected String message
```
  - deprecated
```
protected Boolean deprecated
```
  - includeSchemaComment
```
protected Boolean includeSchemaComment
```
- Constructor Detail
  - CommentType
```
public CommentType()
```
- Method Detail
  - 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)
```
    Sets the value of the deprecated property.
    
    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)
```
    Sets the value of the includeSchemaComment property.
    
    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)
```
  - withIncludeSchemaComment
```
public CommentType withIncludeSchemaComment(Boolean value)
```
  - 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

Modifier and Type	Field	Description
`protected Boolean`	`deprecated`
`protected String`	`expression`
`protected Boolean`	`includeSchemaComment`
`protected String`	`message`

Class CommentType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

expression

message

deprecated

includeSchemaComment

Constructor Detail

CommentType

Method Detail

getExpression

setExpression

getMessage

setMessage

isDeprecated

setDeprecated

isIncludeSchemaComment

setIncludeSchemaComment

withExpression

withMessage

withDeprecated

withIncludeSchemaComment

appendTo

toString

equals

hashCode