Interface CodeItem

All Known Subinterfaces:

CodeAdvancedMergeableItem<S>, CodeAnnotation, CodeAnnotations, CodeArrayInstatiation, CodeArrayType, CodeAssignment, CodeAtomicStatement, CodeBlock, CodeBlockBody, CodeBlockComment, CodeBlockDoWhile, CodeBlockFor, CodeBlockIf, CodeBlockInitializer, CodeBlockStatement, CodeBlockWhileDo, CodeBlockWithCondition, CodeCastExpression, CodeComment, CodeComments, CodeComparisonOperator, CodeComparisonOperatorExpression, CodeComposedType, CodeCondition, CodeConstant, CodeConstructor, CodeConstructorInvocation, CodeConstructors, CodeDoc, CodeElement, CodeElementWithDeclaringType, CodeElementWithModifiers, CodeElementWithName, CodeElementWithTypeVariables, CodeException, CodeExceptions, CodeExpression, CodeExpressionCondition, CodeField, CodeFieldReference, CodeFields, CodeFile, CodeForEachExpression, CodeForExpression, CodeForLoopExpression, CodeFunction, CodeGenericType, CodeGenericTypeParameters<P>, CodeImport, CodeImportItem, CodeImports, CodeInlineComment, CodeItemWithComment, CodeItemWithDeclaration, CodeItemWithDeclaringType, CodeItemWithModifiers, CodeItemWithName, CodeItemWithQualifiedFlag, CodeItemWithQualifiedName, CodeItemWithQualifiedNameAndParentPackage, CodeItemWithType, CodeItemWithVariables, CodeLambdaExpression, CodeLiteral, CodeLocalVariable, CodeLocalVariables, CodeMember, CodeMemberReference, CodeMembers<M>, CodeMergeableItem<S>, CodeMethod, CodeMethodInvocation, CodeMethods, CodeMutableItem, CodeMutableItemWithComment, CodeMutableItemWithQualifiedName, CodeMutableItemWithType, CodeNAryArbitraryOperator, CodeNAryBooleanOperator, CodeNAryHybridOperator, CodeNAryNumericOperator, CodeNAryOperator, CodeNAryOperatorExpression, CodeNestedTypes, CodeNodeItem, CodeNodeItemContainer<I>, CodeNodeItemContainerFlat<I>, CodeNodeItemContainerFlatWithName<I>, CodeNodeItemContainerHierarchical<I>, CodeNodeItemContainerHierarchicalWithName<I>, CodeNodeItemContainerWithName<I>, CodeNodeItemCopyable<P,SELF>, CodeNodeItemWithDeclaringElement, CodeNodeItemWithDeclaringMember, CodeNodeItemWithDeclaringOperation, CodeOperation, CodeOperationArg, CodeOperationArgs<A>, CodeOperationInvocation, CodeOperations<O>, CodeOperator, CodeOperatorExpression, CodePackage, CodeParameter, CodeParameterizedType, CodeParameters, CodePathElement, CodePathElements, CodeProperties, CodeProperty, CodeRegularAssignment, CodeReturn, CodeReturnStatement, CodeSimpleMergeableItem<S>, CodeSingleComment, CodeSingleLineComment, CodeStatement, CodeSuperTypes, CodeTernaryExpression, CodeType, CodeTypeParameters, CodeTypePlaceholder, CodeTypeVariable, CodeTypeVariables, CodeTypeWildcard, CodeUnaryOperator, CodeUnaryOperatorExpression, CodeVariable, CodeVariableThis

public interface CodeItem

Abstract top-level interface for any item of code as defined by this API. It reflects code structure.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_INDENT	The default indent (2 spaces).
static final String	DEFAULT_NEWLINE	The default newline (line feed).

Method Summary

Modifier and Type	Method	Description
default CodeLanguage	getLanguage()
String	getSourceCode()
default String	write()
default void	write(Appendable sink)
default void	write(Appendable sink, String newline)
default void	write(Appendable sink, String newline, String defaultIndent)
default void	write(Appendable sink, String newline, String defaultIndent, String currentIndent)
void	write(Appendable sink, String newline, String defaultIndent, String currentIndent, CodeLanguage language)

Field Details

DEFAULT_NEWLINE

static final String DEFAULT_NEWLINE

The default newline (line feed).

See Also:

• Constant Field Values

DEFAULT_INDENT

static final String DEFAULT_INDENT

The default indent (2 spaces).

See Also:

• Constant Field Values

Method Details

write

default String write()

Returns:

the source-code of this item.

write

default void write(Appendable sink)

Parameters:

sink - the Appendable where to append the source code from this CodeItem.

write

default void write(Appendable sink,
 String newline)

Parameters:

sink - the Appendable where to append the source code from this CodeItem.

newline - the newline String.

write

default void write(Appendable sink,
 String newline,
 String defaultIndent)

Parameters:

sink - the Appendable where to append the source code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

write

default void write(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)

Parameters:

sink - the Appendable where to append the source code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the defaultIndent will be appended.

getLanguage

default CodeLanguage getLanguage()

Returns:

the CodeLanguage to use.

write

void write(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent,
 CodeLanguage language)

Parameters:

sink - the Appendable where to append the source code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the defaultIndent will be appended.

language - the CodeLanguage to use.

getSourceCode

String getSourceCode()

Returns:

the source code of this item.

See Also:

• write(Appendable)