Interface CodeItemWithComment

All Superinterfaces:

CodeItem

All Known Subinterfaces:

CodeAnnotation, CodeArrayType, CodeComposedType, CodeConstructor, CodeElement, CodeElementWithDeclaringType, CodeElementWithModifiers, CodeElementWithName, CodeElementWithTypeVariables, CodeException, CodeField, CodeFile, CodeGenericType, CodeMember, CodeMethod, CodeMutableItemWithComment, CodeOperation, CodeOperationArg, CodePackage, CodeParameter, CodeParameterizedType, CodePathElement, CodeProperty, CodeReturn, CodeType, CodeTypePlaceholder, CodeTypeVariable, CodeTypeWildcard

public interface CodeItemWithComment
extends CodeItem

CodeItem that has an optional comment.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
CodeComment	getComment()

Methods inherited from interface CodeItem

getLanguage, getSourceCode, write, write, write, write, write, write

Method Details

getComment

CodeComment getComment()

Returns:

the CodeComment comment above this item (e.g. header of CodeFile). Will be an empty instance as fallback to avoid NullPointerExceptions.