PrinterAdapter (JSweet transpiler 2.2.0-SNAPSHOT API)

java.lang.Object
- org.jsweet.transpiler.extension.PrinterAdapter

Direct Known Subclasses:

AddPrefixToNonPublicMembersAdapter, BigDecimalAdapter, DisallowGlobalVariablesAdapter, Java2TypeScriptAdapter, MapAdapter, StringEnumAdapter
```
public class PrinterAdapter
extends Object
```
A printer adapter, which can be overridden to change the default printer behavior. Adapters are composable/chainable objects (decorator pattern).

Author:

Renaud Pawlak

Field Summary

Fields
Modifier and Type	Field and Description
`protected JSweetContext`	`context`
`protected org.apache.log4j.Logger`	`logger`
`Set<TypeParameterElement>`	`typeVariablesToErase` A list of type variables to be erased (mapped to any).

Constructor Summary

Constructors
Constructor and Description
`PrinterAdapter(JSweetContext context)` Creates a root adapter (with no parent).
`PrinterAdapter(PrinterAdapter parentAdapter)` Creates a new adapter that will try delegate to the given parent adapter when not implementing its own behavior.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`adaptDocComment(Element element, String commentText)` Adapts the JavaDoc comment for a given element.
`void`	`addAnnotation(Class<? extends Annotation> annotationType, String... filters)` Adds an annotation on the AST through global filters.
`void`	`addAnnotation(String annotationDescriptor, String... filters)` Adds an annotation on the AST through global filters.
`void`	`addAnnotationManager(AnnotationManager annotationManager)` Adds an annotation manager that will tune (add or remove) annotations on the AST.
`void`	`addAnnotationWithValue(Class<? extends Annotation> annotationType, Object value, String... filters)` Adds an annotation on the AST through global filters.
`void`	`addHeader(String key, String header)` This method sets a header to the currently printed file.
`void`	`addTypeMapping(BiFunction<ExtendedElement,String,Object> mappingFunction)` Adds a type mapping so that this adapter substitutes the source type tree with a target type during the transpilation process.
`protected void`	`addTypeMapping(String sourceTypeName, String targetTypeName)` Adds a type mapping so that this adapter substitutes the source type with the target type during the transpilation process.
`protected void`	`addTypeMappings(Map<String,String> nameMappings)` Adds a set of name-based type mappings.
`void`	`afterType(TypeElement type)` This method is called after a type was printed.
`PrinterAdapter`	`endIndent()` Decrements the current indentation value.
`boolean`	`eraseSuperClass(TypeElement type, TypeElement superClass)` Tells if a super class has to be erased in the generated source.
`boolean`	`eraseSuperInterface(TypeElement type, TypeElement superInterface)` Tells if a super interface has to be erased in the generated source.
`ExecutableElement`	`findExecutableDeclarationInType(TypeElement type, MethodInvocationElement invocation)` Looks-up the executable that is invoked by the given invocation.
`<T> T`	`getAnnotationValue(Element element, String annotationType, Class<T> propertyClass, T defaultValue)` Gets the first value of the 'value' property for the given annotation type if found on the given element.
`<T> T`	`getAnnotationValue(Element element, String annotationType, String propertyName, Class<T> propertyClass, T defaultValue)` Gets the first value of the given property for the given annotation type if found on the given element.
`JSweetContext`	`getContext()` Gets the transpiler's context.
`Set<String>`	`getErasedTypes()`
`protected List<BiFunction<ExtendedElement,String,Object>>`	`getFunctionalTypeMappings()` Gets the functional type mappings.
`String`	`getHeader(String key)` Gets the header associated to the given key (null if non-existing key).
`String`	`getMappedType(TypeMirror type)` Gets the string that corresponds to the given type, taking into account all type mappings.
`ModuleImportDescriptor`	`getModuleImportDescriptor(CompilationUnitElement currentCompilationUnit, String importedName, TypeElement importedClass)` This method implements the default behavior to generate module imports.
`PrinterAdapter`	`getParentAdapter()` Gets the parent adapter.
`ExtendedElement`	`getParentElement()` Gets the parent element in the printer's scanning stack.
`<T extends Element> T`	`getParentElement(Class<T> type)` Gets the parent element in the printer's scanning stack.
`AbstractTreePrinter`	`getPrinter()` Gets the printer on which rely the adapter (this is not recommended).
`String`	`getRootRelativeName(Element element)` Gets the qualified name of an element, relatively to a possible `@Root` annotation.
`JSweetOptions`	`getTranspilerOptions()` Gets the transpiler options.
`protected String`	`getTypeMappingTarget(String sourceTypeName)` Returns the type the given type name is mapped through the `addTypeMapping(String, String)` or `addTypeMapping(String, String)` function.
`boolean`	`hasAnnotationType(Element element, String... annotationTypes)` Returns true if the given element is annotated with one of the given annotation types.
`boolean`	`isAmbientDeclaration(Element element)` Tells if the given element is ambient (part of a def.* package or within an `@Ambient`-annotated scope).
`protected boolean`	`isMappedType(String sourceTypeName)` Returns true if the given type name is mapped through the `addTypeMapping(String, String)` or `addTypeMapping(String, String)` function.
`boolean`	`isSubstituteSuperTypes()` Tells if this adapter substitutes types in extends or implements clauses.
`String`	`needsImport(ImportElement importElement, String qualifiedName)` Returns the import qualified id if the given import requires an import statement to be printed.
`PrinterAdapter`	`print(ExtendedElement element)` Prints a generic element by delegating to the printer.
`PrinterAdapter`	`print(Name name)` Prints a name by delegating to the printer.
`PrinterAdapter`	`print(String string)` Prints a string by delegating to the printer.
`void`	`print(String exprStr, ExtendedElement expr)` Print either a string, or a tree if the string is null.
`PrinterAdapter`	`printArgList(List<? extends ExtendedElement> args)` Prints an argument list by delegating to the printer.
`PrinterAdapter`	`printIdentifierList(String prefix, int count)` Prints a comma-separated, zero-indexed, generated identifier list.
`PrinterAdapter`	`printIndent()` Prints an indentation for the current indentation value.
`PrinterAdapter`	`println()` Prints a new line by delegating to the printer.
`protected void`	`printMacroName(String macroName)` Print the macro name in the code.
`PrinterAdapter`	`removeLastChar()` Removes the last output character.
`boolean`	`removeLastChar(char expectedChar)` removes last character if expectedChar
`PrinterAdapter`	`removeLastChars(int count)` Removes the last output characters.
`PrinterAdapter`	`removeLastIndent()` Removes the last printed indentation.
`protected void`	`report(Element element, JSweetProblem problem, Object... params)` Reports a problem during the printing phase.
`protected void`	`report(Element element, Name name, JSweetProblem problem, Object... params)` Reports a problem during the printing phase.
`protected void`	`report(ExtendedElement element, JSweetProblem problem, Object... params)` Reports a problem during the printing phase.
`protected void`	`report(ExtendedElement element, Name name, JSweetProblem problem, Object... params)` Reports a problem during the printing phase.
`void`	`setParentAdapter(PrinterAdapter parentAdapter)` Sets the parent adapter.
`void`	`setPrinter(AbstractTreePrinter printer)` Sets the printer attached to this adapter.
`PrinterAdapter`	`space()` Adds a space to the output.
`PrinterAdapter`	`startIndent()` Increments the current indentation value.
`boolean`	`substitute(ExtendedElement extendedElement)` Upcalled by the transpiler to forward to the right subtitution method depending on the actual extended element type.
`boolean`	`substituteArrayAccess(ArrayAccessElement arrayAccess)` Substitutes the value of an array access expression.
`boolean`	`substituteAssignment(AssignmentElement assignment)` Substitutes the value of a field assignment expression.
`boolean`	`substituteAssignmentWithOperator(AssignmentWithOperatorElement assignment)` Substitutes the value of an assignment with operator (a += b) expression.
`boolean`	`substituteBinaryOperator(BinaryOperatorElement binaryOperator)` Substitutes the value of a binary operator.
`boolean`	`substituteCaseStatementPattern(CaseElement caseStatement, ExtendedElement pattern)` Substitutes if necessary the pattern of a case statement.
`boolean`	`substituteForEachLoop(ForeachLoopElement foreachLoop, boolean targetHasLength, String indexVarName)` Substitutes if necessary the given foreach loop.
`boolean`	`substituteIdentifier(IdentifierElement identifier)` Substitutes the value of an identifier.
`boolean`	`substituteInstanceof(String exprStr, ExtendedElement expr, TypeMirror type)` Substitutes if necessary an instanceof expression.
`boolean`	`substituteMethodInvocation(MethodInvocationElement invocation)` Substitutes the value of a method invocation expression.
`boolean`	`substituteNewClass(NewClassElement newClass)` To override to tune the printing of a new class expression.
`boolean`	`substituteUnaryOperator(UnaryOperatorElement unaryOperator)` Substitutes the value of a unary operator.
`boolean`	`substituteVariableAccess(VariableAccessElement variableAccess)` Substitutes the given variable access.
`Types`	`types()` Gets the types API, which provides a set of utilities on TypeMirror.
`Util`	`util()` Gets the util API, which provides a set of utilities.

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

- Field Detail
  - logger
```
protected org.apache.log4j.Logger logger
```
  - context
```
protected JSweetContext context
```
  - typeVariablesToErase
```
public Set<TypeParameterElement> typeVariablesToErase
```
    A list of type variables to be erased (mapped to any).
- Constructor Detail
  - PrinterAdapter
```
public PrinterAdapter(JSweetContext context)
```
    Creates a root adapter (with no parent).
    
    Parameters:
    
    context - the transpilation context
  - PrinterAdapter
```
public PrinterAdapter(PrinterAdapter parentAdapter)
```
    Creates a new adapter that will try delegate to the given parent adapter when not implementing its own behavior.
    
    Parameters:
    
    parentAdapter - cannot be null: if no parent you must use the #AbstractPrinterAdapter(JSweetContext) constructor
- Method Detail
  - getContext
```
public JSweetContext getContext()
```
    Gets the transpiler's context.
  - addTypeMapping
```
protected final void addTypeMapping(String sourceTypeName,
                                    String targetTypeName)
```
    Adds a type mapping so that this adapter substitutes the source type with the target type during the transpilation process.
    
    Parameters:
    
    sourceTypeName - the fully qualified name of the type to be substituted
    
    targetTypeName - the fully Qualified name of the type the source type is mapped to
  - addTypeMappings
```
protected final void addTypeMappings(Map<String,String> nameMappings)
```
    Adds a set of name-based type mappings. This method is equivalent to calling addTypeMapping(String, String) for each entry of the given map.
  - isMappedType
```
protected final boolean isMappedType(String sourceTypeName)
```
    Returns true if the given type name is mapped through the addTypeMapping(String, String) or addTypeMapping(String, String) function.
  - getTypeMappingTarget
```
protected final String getTypeMappingTarget(String sourceTypeName)
```
    Returns the type the given type name is mapped through the addTypeMapping(String, String) or addTypeMapping(String, String) function.
  - getFunctionalTypeMappings
```
protected final List<BiFunction<ExtendedElement,String,Object>> getFunctionalTypeMappings()
```
    Gets the functional type mappings.
  - addTypeMapping
```
public void addTypeMapping(BiFunction<ExtendedElement,String,Object> mappingFunction)
```
    Adds a type mapping so that this adapter substitutes the source type tree with a target type during the transpilation process.
    
    Parameters:
    
    mappingFunction - a function that takes the type tree, the type name, and returns a substitution (either under the form of a string, or of a string, or of another type tree).
  - getMappedType
```
public final String getMappedType(TypeMirror type)
```
    Gets the string that corresponds to the given type, taking into account all type mappings.
    Some type mappings are set by default, some are added in the context by adapters.
  - addAnnotation
```
public final void addAnnotation(Class<? extends Annotation> annotationType,
                                String... filters)
```
    Adds an annotation on the AST through global filters.
    Example:
```
 context.addAnnotation(FunctionalInterface.class, "**.MyInterface");
 
```
    Filters are simplified regular expressions matching on the Java AST. Special characters are the following:
    - *: matches any token/identifier in the signature of the AST element
    - **: matches any list of tokens in signature of the AST element (same as ..)
    - ..: matches any list of tokens in signature of the AST element (same as **)
    - !: negates the filter (first character only)
    For example, to match:
    - all the elements in the x.y.z package: x.y.z.*
    - all the elements and subelements (fields, methods, ...) in the x.y.z package: x.y.z.**
    - all the methods in the x.y.z.A class: x.y.z.A.*(..)
    - all the methods taking 2 arguments in the x.y.z.A class: x.y.z.A.*(*,*)
    - all fields call aField in all the classes: **.aField
    Parameters:
    
    annotationType - the annotation type
    
    filters - the annotation is activated if one of the filters match and no negative filter matches
  - addAnnotationWithValue
```
public final void addAnnotationWithValue(Class<? extends Annotation> annotationType,
                                         Object value,
                                         String... filters)
```
    Adds an annotation on the AST through global filters. The annotation to be added is described by its type and by a value, which is passed as is to the annotation's value. If the annotation type does not accept a value parameter, no annotations will be added.
    
    See Also:
    
    addAnnotation(String, String...)
  - addAnnotationManager
```
public final void addAnnotationManager(AnnotationManager annotationManager)
```
    Adds an annotation manager that will tune (add or remove) annotations on the AST. Lastly added managers have precedence over firstly added ones.
  - hasAnnotationType
```
public final boolean hasAnnotationType(Element element,
                                       String... annotationTypes)
```
    Returns true if the given element is annotated with one of the given annotation types. To change the behavior of this method in a composable way, use addAnnotation(Class, String...) or addAnnotationManager(AnnotationManager).
  - getAnnotationValue
```
public final <T> T getAnnotationValue(Element element,
                                      String annotationType,
                                      Class<T> propertyClass,
                                      T defaultValue)
```
    Gets the first value of the 'value' property for the given annotation type if found on the given element. To change the behavior of this method in a composable way, use addAnnotation(Class, String...) or addAnnotationManager(AnnotationManager).
    
    Parameters:
    
    element - the element holding the annotation
    
    annotationType - the fully qualified name of the value property type
    
    propertyClass - the expected class of the property (String.class, TypeMirror.class, Number.class, and arrays such as String[].class...)
    
    defaultValue - the default value if the property is not found
  - getAnnotationValue
```
public final <T> T getAnnotationValue(Element element,
                                      String annotationType,
                                      String propertyName,
                                      Class<T> propertyClass,
                                      T defaultValue)
```
    Gets the first value of the given property for the given annotation type if found on the given element.
    
    Parameters:
    
    element - the element holding the annotation
    
    annotationType - the fully qualified name of the value property type
    
    propertyName - the name of the property in the annotation (null will look up the value property)
    
    propertyClass - the expected class of the property (String.class, TypeMirror.class, Number.class, and arrays such as String[].class...)
    
    defaultValue - the default value if the property is not found
  - addAnnotation
```
public final void addAnnotation(String annotationDescriptor,
                                String... filters)
```
    Adds an annotation on the AST through global filters.
    Example:
```
 context.addAnnotation("@Erased", "*.writeObject(*)");
 context.addAnnotation("@Name('newName')", "*.MyDeclarationToBeRenamed");
 
```
    Filters are simplified regular expressions matching on the Java AST. Special characters are the following:
    - *: matches any character in the signature of the AST element
    - !: negates the filter (first character only)
    Parameters:
    
    annotationDescriptor - the annotation type name, optionally preceded with a @, and optionally defining a value (fully qualified name is not necessary for JSweet annotations)
    
    filters - the annotation is activated if one of the filters match and no negative filter matches
  - print
```
public PrinterAdapter print(ExtendedElement element)
```
    Prints a generic element by delegating to the printer.
  - print
```
public PrinterAdapter print(String string)
```
    Prints a string by delegating to the printer.
  - print
```
public PrinterAdapter print(Name name)
```
    Prints a name by delegating to the printer.
  - println
```
public PrinterAdapter println()
```
    Prints a new line by delegating to the printer.
  - printArgList
```
public PrinterAdapter printArgList(List<? extends ExtendedElement> args)
```
    Prints an argument list by delegating to the printer.
  - printIdentifierList
```
public PrinterAdapter printIdentifierList(String prefix,
                                          int count)
```
    Prints a comma-separated, zero-indexed, generated identifier list.
    For instance printIdentifierList("x", 4) will print: x0, x1, x2, x3.
    
    Parameters:
    
    prefix - the prefix of the identifiers
    
    count - the number of identifiers in the list
    
    Returns:
    
    this printer adapter
  - print
```
public void print(String exprStr,
                  ExtendedElement expr)
```
    Print either a string, or a tree if the string is null.
  - printIndent
```
public PrinterAdapter printIndent()
```
    Prints an indentation for the current indentation value.
  - startIndent
```
public final PrinterAdapter startIndent()
```
    Increments the current indentation value.
  - endIndent
```
public final PrinterAdapter endIndent()
```
    Decrements the current indentation value.
  - space
```
public final PrinterAdapter space()
```
    Adds a space to the output.
  - removeLastChar
```
public final boolean removeLastChar(char expectedChar)
```
    removes last character if expectedChar
  - removeLastChar
```
public final PrinterAdapter removeLastChar()
```
    Removes the last output character.
  - removeLastChars
```
public final PrinterAdapter removeLastChars(int count)
```
    Removes the last output characters.
  - removeLastIndent
```
public final PrinterAdapter removeLastIndent()
```
    Removes the last printed indentation.
  - getParentElement
```
public final ExtendedElement getParentElement()
```
    Gets the parent element in the printer's scanning stack.
  - getParentElement
```
public final <T extends Element> T getParentElement(Class<T> type)
```
    Gets the parent element in the printer's scanning stack.
  - findExecutableDeclarationInType
```
public final ExecutableElement findExecutableDeclarationInType(TypeElement type,
                                                               MethodInvocationElement invocation)
```
    Looks-up the executable that is invoked by the given invocation.
  - getRootRelativeName
```
public final String getRootRelativeName(Element element)
```
    Gets the qualified name of an element, relatively to a possible @Root annotation.
  - report
```
protected void report(ExtendedElement element,
                      JSweetProblem problem,
                      Object... params)
```
    Reports a problem during the printing phase.
    
    Parameters:
    
    element - the code where the problem occurred
    
    problem - the reported problem
    
    params - the parameters if any
  - report
```
protected void report(ExtendedElement element,
                      Name name,
                      JSweetProblem problem,
                      Object... params)
```
    Reports a problem during the printing phase.
    
    Parameters:
    
    element - the code where the problem occurred
    
    name - the name of the element if any
    
    problem - the reported problem
    
    params - the parameters if any
  - report
```
protected void report(Element element,
                      JSweetProblem problem,
                      Object... params)
```
    Reports a problem during the printing phase.
    
    Parameters:
    
    element - the code where the problem occurred
    
    problem - the reported problem
    
    params - the parameters if any
  - report
```
protected void report(Element element,
                      Name name,
                      JSweetProblem problem,
                      Object... params)
```
    Reports a problem during the printing phase.
    
    Parameters:
    
    element - the code where the problem occurred
    
    name - the name of the element if any
    
    problem - the reported problem
    
    params - the parameters if any
  - substituteArrayAccess
```
public boolean substituteArrayAccess(ArrayAccessElement arrayAccess)
```
    Substitutes the value of an array access expression.
    
    Parameters:
    
    arrayAccess - the array access being printed
    
    Returns:
    
    true if substituted
  - substituteBinaryOperator
```
public boolean substituteBinaryOperator(BinaryOperatorElement binaryOperator)
```
    Substitutes the value of a binary operator.
    
    Parameters:
    
    binaryOperator - the binary operator being printed
    
    Returns:
    
    true if substituted
  - substituteUnaryOperator
```
public boolean substituteUnaryOperator(UnaryOperatorElement unaryOperator)
```
    Substitutes the value of a unary operator.
    
    Parameters:
    
    unaryOperator - the unary operator being printed
    
    Returns:
    
    true if substituted
  - substituteIdentifier
```
public boolean substituteIdentifier(IdentifierElement identifier)
```
    Substitutes the value of an identifier.
    
    Parameters:
    
    identifier - the identifier being printed
    
    Returns:
    
    true if substituted
  - substituteNewClass
```
public boolean substituteNewClass(NewClassElement newClass)
```
    To override to tune the printing of a new class expression.
    
    Parameters:
    
    newClass - the new class expression
    
    Returns:
    
    true if substituted
  - substitute
```
public final boolean substitute(ExtendedElement extendedElement)
```
    Upcalled by the transpiler to forward to the right subtitution method depending on the actual extended element type.
  - substituteVariableAccess
```
public boolean substituteVariableAccess(VariableAccessElement variableAccess)
```
    Substitutes the given variable access.
    
    Parameters:
    
    variableAccess - the variable access being printed
    
    Returns:
    
    true if substituted
  - needsImport
```
public String needsImport(ImportElement importElement,
                          String qualifiedName)
```
    Returns the import qualified id if the given import requires an import statement to be printed.
    
    Parameters:
    
    importElement - the given import declaration
    
    qualifiedName - the qualified import id
    
    Returns:
    
    the possibly adapted qualified id or null if the import should be ignored by the printer
  - getModuleImportDescriptor
```
public ModuleImportDescriptor getModuleImportDescriptor(CompilationUnitElement currentCompilationUnit,
                                                        String importedName,
                                                        TypeElement importedClass)
```
    This method implements the default behavior to generate module imports. It may be overridden by subclasses to implement specific behaviors.
    
    Parameters:
    
    currentCompilationUnit - the currently transpiled compilation unit
    
    importedName - the name to be imported
    
    importedClass - the class being imported
    
    Returns:
    
    a ModuleImportDescriptor instance that will be used to generate the TypeScript import statement
  - substituteMethodInvocation
```
public boolean substituteMethodInvocation(MethodInvocationElement invocation)
```
    Substitutes the value of a method invocation expression.
    
    Parameters:
    
    invocation - the invocation being printed
    
    Returns:
    
    true if substituted
  - substituteAssignment
```
public boolean substituteAssignment(AssignmentElement assignment)
```
    Substitutes the value of a field assignment expression.
    
    Parameters:
    
    assignment - the field assignment being printed
    
    Returns:
    
    true if substituted
  - substituteAssignmentWithOperator
```
public boolean substituteAssignmentWithOperator(AssignmentWithOperatorElement assignment)
```
    Substitutes the value of an assignment with operator (a += b) expression.
    
    Parameters:
    
    assignment - the assignment being printed
    
    Returns:
    
    true if substituted
  - getPrinter
```
public AbstractTreePrinter getPrinter()
```
    Gets the printer on which rely the adapter (this is not recommended).
    Accessing the printer with this method allows the user to access the internal javac API directly (com.sun.tools.javac), which is non-standard and may get deprecated in future Java versions. As a consequence, to write sustainable adapters, it is not recommended to use the printer API.
    Instead, use the adapter's API directly, which relies on an abstraction of the AST: javax.lang.model and org.jsweet.transpiler.model. If some feature seems to be missing, please contact JSweet.org to help improving this API.
  - setPrinter
```
public void setPrinter(AbstractTreePrinter printer)
```
    Sets the printer attached to this adapter.
  - getErasedTypes
```
public Set<String> getErasedTypes()
```
  - substituteForEachLoop
```
public boolean substituteForEachLoop(ForeachLoopElement foreachLoop,
                                     boolean targetHasLength,
                                     String indexVarName)
```
    Substitutes if necessary the given foreach loop.
    
    Parameters:
    
    foreachLoop - the foreach loop to print
    
    targetHasLength - true if the iterable defines a public length field
    
    indexVarName - a possible (fresh) variable name that can used to iterate
  - eraseSuperClass
```
public boolean eraseSuperClass(TypeElement type,
                               TypeElement superClass)
```
    Tells if a super class has to be erased in the generated source.
  - eraseSuperInterface
```
public boolean eraseSuperInterface(TypeElement type,
                                   TypeElement superInterface)
```
    Tells if a super interface has to be erased in the generated source.
  - isSubstituteSuperTypes
```
public boolean isSubstituteSuperTypes()
```
    Tells if this adapter substitutes types in extends or implements clauses.
  - substituteInstanceof
```
public boolean substituteInstanceof(String exprStr,
                                    ExtendedElement expr,
                                    TypeMirror type)
```
    Substitutes if necessary an instanceof expression.
    
    Parameters:
    
    exprStr - the expression being tested as a string (null if provided as a tree)
    
    expr - the expression being tested as a tree (null if provided as a string)
    
    type - the type of the instanceof expression
    
    Returns:
    
    true if substituted
  - substituteCaseStatementPattern
```
public boolean substituteCaseStatementPattern(CaseElement caseStatement,
                                              ExtendedElement pattern)
```
    Substitutes if necessary the pattern of a case statement.
  - afterType
```
public void afterType(TypeElement type)
```
    This method is called after a type was printed.
  - adaptDocComment
```
public String adaptDocComment(Element element,
                              String commentText)
```
    Adapts the JavaDoc comment for a given element.
    
    Parameters:
    
    element - the documented element
    
    commentText - the comment text if any (null when no comment)
    
    Returns:
    
    the adapted comment (null will remove the JavaDoc comment)
  - getParentAdapter
```
public PrinterAdapter getParentAdapter()
```
    Gets the parent adapter. By default, an adapter delegates to the parent adapter when the behavior is not overridden.
  - setParentAdapter
```
public void setParentAdapter(PrinterAdapter parentAdapter)
```
    Sets the parent adapter. By default, an adapter delegates to the parent adapter when the behavior is not overridden.
  - types
```
public Types types()
```
    Gets the types API, which provides a set of utilities on TypeMirror.
    
    See Also:
    
    TypeMirror, Element.asType(), ExtendedElement.getType()
  - util
```
public Util util()
```
    Gets the util API, which provides a set of utilities.
  - printMacroName
```
protected final void printMacroName(String macroName)
```
    Print the macro name in the code.
  - isAmbientDeclaration
```
public final boolean isAmbientDeclaration(Element element)
```
    Tells if the given element is ambient (part of a def.* package or within an @Ambient-annotated scope).
  - getTranspilerOptions
```
public final JSweetOptions getTranspilerOptions()
```
    Gets the transpiler options.
  - addHeader
```
public final void addHeader(String key,
                            String header)
```
    This method sets a header to the currently printed file. This header can be TypeScript code, but use with caution since it may raise compilation errors.
    Several headers can be added to the same file. Note that a new line will be automatically added at the end of the last header (if any), but not between each header. Headers will be printer in the order they have been added to the file. Headers are reset for each new file.
    
    Parameters:
    
    key - a key to identify the header (see getHeader(String))
    
    header - any string that will be printed at the beginning of the file (only when not in bundle mode)
    
    See Also:
    
    getHeader(String)
  - getHeader
```
public final String getHeader(String key)
```
    Gets the header associated to the given key (null if non-existing key).
    
    Parameters:
    
    key - the header's key as set by addHeader(String, String)
    
    Returns:
    
    the associated header (null if non-existing key)
    
    See Also:
    
    addHeader(String, String)

Class PrinterAdapter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

context

typeVariablesToErase

Constructor Detail

PrinterAdapter

PrinterAdapter

Method Detail

getContext

addTypeMapping

addTypeMappings

isMappedType

getTypeMappingTarget

getFunctionalTypeMappings

addTypeMapping

getMappedType

addAnnotation

addAnnotationWithValue

addAnnotationManager

hasAnnotationType

getAnnotationValue

getAnnotationValue

addAnnotation

print

print

print

println

printArgList

printIdentifierList

print

printIndent

startIndent

endIndent

space

removeLastChar

removeLastChar

removeLastChars

removeLastIndent

getParentElement

getParentElement

findExecutableDeclarationInType

getRootRelativeName

report

report

report

report

substituteArrayAccess

substituteBinaryOperator

substituteUnaryOperator

substituteIdentifier

substituteNewClass

substitute

substituteVariableAccess

needsImport

getModuleImportDescriptor

substituteMethodInvocation

substituteAssignment

substituteAssignmentWithOperator

getPrinter

setPrinter

getErasedTypes

substituteForEachLoop

eraseSuperClass

eraseSuperInterface

isSubstituteSuperTypes

substituteInstanceof

substituteCaseStatementPattern

afterType

adaptDocComment

getParentAdapter

setParentAdapter

types

util

printMacroName

isAmbientDeclaration