Class AbstractCodeLanguage

java.lang.Object

io.github.mmm.code.api.language.AbstractCodeLanguage

All Implemented Interfaces:

CodeLanguage

Direct Known Subclasses:

JavaLanguage

public abstract class AbstractCodeLanguage
extends Object
implements CodeLanguage

The default implementation of CodeLanguage (for Java).

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor	Description
AbstractCodeLanguage()

Method Summary

Modifier and Type	Method	Description
protected CodeModifiers	getMethodModifiers(CodeMethod method)
protected abstract Pattern	getNamePattern(CodeItemWithName item)
protected String	getOperationName(CodeOperation operation)
protected abstract Pattern	getSimpleNamePatternForPackage()
protected abstract Pattern	getSimpleNamePatternForType()
protected abstract boolean	isRevervedKeyword(String name, CodeItem item)
protected String	verifyName(CodeItem item, Pattern pattern, String name)
String	verifyName(CodeItemWithName item, String name)
String	verifySimpleName(CodeItemWithQualifiedName item, String simpleName)
void	writeAnnotations(CodeAnnotations annotations, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given CodeAnnotations.
void	writeBody(CodeOperation operation, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given CodeOperation.
void	writeBody(CodeType type, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the type body (e.g.
void	writeComment(CodeComment comment, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given CodeComment.
void	writeConstructor(CodeConstructor constructor, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given CodeConstructor.
void	writeDeclaration(CodeVariable variable, Appendable sink)	Writes a variable declaration.
void	writeDeclaration(CodeType type, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes a type declaration (e.g.
void	writeDoc(CodeDoc doc, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given CodeDoc.
void	writeElement(CodeElement element, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the CodeDoc, CodeComment, and CodeAnnotations of the given CodeElement.
void	writeField(CodeField field, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given field (e.g.
void	writeMethod(CodeMethod method, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given method (e.g.
protected void	writeOperation(CodeOperation operation, CodeModifiers modifiers, CodeReturn opReturn, Appendable sink, String newline, String defaultIndent, String currentIndent)
void	writeParameters(CodeParameters parameters, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given CodeParameters.
protected void	writeTypeReferenceBegin(CodeGenericType type, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the type reference at the beginning.
protected void	writeTypeReferenceEnd(CodeGenericType type, Appendable sink, String newline, String defaultIndent, String currentIndent)
void	writeTypeVariables(CodeTypeVariables typeVariables, Appendable sink, String newline, String defaultIndent, String currentIndent)	Writes the given CodeTypeVariables.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface CodeLanguage

getAnnotationEndIfEmpty, getAnnotationStart, getFileFilename, getKeywordForCategory, getKeywordForExtends, getKeywordForImplements, getKeywordForVariable, getLanguageName, getMethodKeyword, getPackageFilename, getPackageSeparator, getStatementTerminator, getVariableNameThis, isSupportingNativeProperties

Constructor Details

AbstractCodeLanguage

public AbstractCodeLanguage()

Method Details

verifyName

public String verifyName(CodeItemWithName item,
 String name)

Specified by:

verifyName in interface CodeLanguage

Parameters:

item - the CodeItemWithName to verify.

name - the new name to verify.

Returns:

the given name (or potentially a "normalized" name that is valid).

verifySimpleName

public String verifySimpleName(CodeItemWithQualifiedName item,
 String simpleName)

Specified by:

verifySimpleName in interface CodeLanguage

Parameters:

item - the CodeItemWithQualifiedName to verify.

simpleName - the new simple name to verify.

Returns:

the given simpleName (or potentially a "normalized" name that is valid).

verifyName

protected String verifyName(CodeItem item,
 Pattern pattern,
 String name)

Parameters:

item - the CodeItem to verify.

pattern - the Pattern defining valid names.

name - the (simple) name to verify.

Returns:

the given name (or potentially a "normalized" name that is valid).

getSimpleNamePatternForPackage

protected abstract Pattern getSimpleNamePatternForPackage()

Returns:

the Pattern that defines valid CodePackage names.

getSimpleNamePatternForType

protected abstract Pattern getSimpleNamePatternForType()

Returns:

the Pattern that defines valid names for CodeType and CodeFile.

getNamePattern

protected abstract Pattern getNamePattern(CodeItemWithName item)

Parameters:

item - the item to verify. May be ignored if pattern and validation is independent of the item type.

Returns:

the Pattern that defines valid names.

isRevervedKeyword

protected abstract boolean isRevervedKeyword(String name,
 CodeItem item)

Parameters:

name - the name of the CodeItem to create.

item - the CodeItem to verify that defines the given name. Will most probably be ignored but a language may allow keywords in specific places and forbid in others.

Returns:

true if the given name is invalid (for the given CodeItem) because it is a reserved keyword.

writeDoc

public void writeDoc(CodeDoc doc,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
              throws IOException

Writes the given CodeDoc.

Parameters:

doc - the CodeDoc to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeComment

public void writeComment(CodeComment comment,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                  throws IOException

Writes the given CodeComment.

Parameters:

comment - the CodeComment to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeAnnotations

public void writeAnnotations(CodeAnnotations annotations,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                      throws IOException

Writes the given CodeAnnotations.

Parameters:

annotations - the CodeAnnotations to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeElement

public void writeElement(CodeElement element,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                  throws IOException

Writes the CodeDoc, CodeComment, and CodeAnnotations of the given CodeElement.

Parameters:

element - the CodeElement to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeDeclaration

public void writeDeclaration(CodeVariable variable,
 Appendable sink)
                      throws IOException

Description copied from interface: CodeLanguage

Writes a variable declaration. E.g. «type» «name» or «name»: «type»

Specified by:

writeDeclaration in interface CodeLanguage

Parameters:

variable - the CodeVariable to write.

sink - the Appendable where to append the code to.

Throws:

IOException - if thrown by Appendable.

writeDeclaration

public void writeDeclaration(CodeType type,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                      throws IOException

Description copied from interface: CodeLanguage

Writes a type declaration (e.g. "public class MyClass").

Specified by:

writeDeclaration in interface CodeLanguage

Parameters:

type - the CodeType to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeBody

public void writeBody(CodeType type,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
               throws IOException

Description copied from interface: CodeLanguage

Writes the type body (e.g. "{\n private String field;\n }\n").

Specified by:

writeBody in interface CodeLanguage

Parameters:

type - the CodeType to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeField

public void writeField(CodeField field,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                throws IOException

Description copied from interface: CodeLanguage

Writes the given field (e.g. "private String field;\n").

Specified by:

writeField in interface CodeLanguage

Parameters:

field - the CodeField to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeMethod

public void writeMethod(CodeMethod method,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                 throws IOException

Description copied from interface: CodeLanguage

Writes the given method (e.g. "String getName();\n").

Specified by:

writeMethod in interface CodeLanguage

Parameters:

method - the CodeField to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeOperation

protected void writeOperation(CodeOperation operation,
 CodeModifiers modifiers,
 CodeReturn opReturn,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                       throws IOException

Parameters:

operation - the CodeOperation to write.

modifiers - the CodeModifiers of the operation, potentially transformed.

opReturn - the CodeReturn of the operation or null for CodeConstructor.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

getOperationName

protected String getOperationName(CodeOperation operation)

Parameters:

operation - the CodeOperation.

Returns:

the name of the given CodeOperation to be written as source-code. May also be "constructor" for CodeConstructor in languages like TypeScript.

writeTypeReferenceBegin

protected void writeTypeReferenceBegin(CodeGenericType type,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                                throws IOException

Writes the type reference at the beginning. In languages like Java this is the place where type references are written. However, some other languages write the type reference at the end. Example: In Java we have the type references at the beginning so this has to be implemented in this method:

abstract String method(long parameter);

In TypeScript however, type references are at the end so this method has to be overridden doing nothing and writeTypeReferenceEnd(CodeGenericType, Appendable, String, String, String) has to be overridden to append a colon followed by the type:

abstract method(parameter:number):string;

Parameters:

type - the CodeGenericType to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeTypeReferenceEnd

protected void writeTypeReferenceEnd(CodeGenericType type,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                              throws IOException

Parameters:

type - the CodeGenericType to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

See Also:

• writeTypeReferenceBegin(CodeGenericType, Appendable, String, String, String)

getMethodModifiers

protected CodeModifiers getMethodModifiers(CodeMethod method)

Parameters:

method - the CodeMethod.

Returns:

the modifiers of the given CodeMethod to write as source-code. However, with potential transformation for this CodeLanguage.

writeConstructor

public void writeConstructor(CodeConstructor constructor,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                      throws IOException

Description copied from interface: CodeLanguage

Writes the given CodeConstructor.

Specified by:

writeConstructor in interface CodeLanguage

Parameters:

constructor - the CodeConstructor to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeParameters

public void writeParameters(CodeParameters parameters,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                     throws IOException

Writes the given CodeParameters.

Parameters:

parameters - the CodeParameters to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeTypeVariables

public void writeTypeVariables(CodeTypeVariables typeVariables,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
                        throws IOException

Writes the given CodeTypeVariables.

Parameters:

typeVariables - the CodeTypeVariables to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.

writeBody

public void writeBody(CodeOperation operation,
 Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent)
               throws IOException

Writes the given CodeOperation.

Parameters:

operation - the CodeOperation to write.

sink - the Appendable where to append the code to.

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.

Throws:

IOException - if thrown by Appendable.