# Class: com.pnfsoftware.jeb.core.units.impl.Comment

Comments are managed by [comment managers](AbstractCommentManager). A comment can consist of: a primary inline string; a secondary top string; a collection of meta comments \(pairs of object/flag\). Comments are not immutable, but should not be attempted to be modified directly. Modifications are to be done by a comment manager.

## Constructor: Comment

Description: Create an empty comment.

## Constructor: Comment
- parameter: `inline`, type: `java.lang.String`

Description: Create an inline comment.
parameter: inline: inline comment text

## Constructor: Comment
- parameter: `inline`, type: `java.lang.String`
- parameter: `pre`, type: `java.lang.String`

Description: Create a comment.
parameter: inline: inline comment text
parameter: pre: pre\-comment text

## Constructor: Comment
- parameter: `inline`, type: `java.lang.String`
- parameter: `pre`, type: `java.lang.String`
- parameter: `metacoll`, type: `java.util.Collection<com.pnfsoftware.jeb.core.units.impl.MetaComment>`

Description: Create a comment.
parameter: inline: inline comment text
parameter: pre: pre\-comment text
parameter: metacoll: meta\-comments

## Method: equals
- parameter: `obj`, type: `java.lang.Object`
- return type: `boolean`


## Method: formatRaw
- return type: `java.lang.String`

Description: Format the comment as raw text.
return: raw formatted comment text

## Method: getInline
- return type: `java.lang.String`

Description: Retrieve the inline comment text.
return: inline comment text, or null if none

## Method: getMetaComments
- return type: `java.util.Collection<com.pnfsoftware.jeb.core.units.impl.MetaComment>`

Description: Retrieve the meta\-comments.
return: meta\-comments, possibly empty

## Method: getMetaComments
- parameter: `flagsMustHave`, type: `int`
- parameter: `flagsCantHave`, type: `int`
- return type: `java.util.Collection<com.pnfsoftware.jeb.core.units.impl.MetaComment>`

Description: Retrieve meta\-comments filtered by flags.
parameter: flagsMustHave: mask of flags that must be present
parameter: flagsCantHave: mask of flags that must be absent
return: filtered meta\-comments, possibly empty

## Method: getPre
- return type: `java.lang.String`

Description: Retrieve the pre\-comment text.
return: pre\-comment text, or null if none

## Method: hashCode
- return type: `int`


## Method: isEmpty
- return type: `boolean`

Description: Determine whether this comment contains no text or meta\-comments.
return: true if empty

## Method: setInline
- parameter: `inline`, type: `java.lang.String`

Description: Set the inline comment text.
parameter: inline: inline comment text

## Method: setPre
- parameter: `pre`, type: `java.lang.String`

Description: Set the pre\-comment text.
parameter: pre: pre\-comment text

## Method: toString
- return type: `java.lang.String`


