spoon.support.sniper

Class SniperJavaPrettyPrinter

java.lang.Object

spoon.reflect.visitor.DefaultJavaPrettyPrinter

spoon.support.sniper.SniperJavaPrettyPrinter

All Implemented Interfaces:

CtVisitor, PrettyPrinter, TokenWriterProxy.Listener

public class SniperJavaPrettyPrinter
extends DefaultJavaPrettyPrinter
implements TokenWriterProxy.Listener

PrettyPrinter implementation, which copies as much as possible from the origin sources and tries to only print the changed elements.

Field Summary

Fields inherited from class spoon.reflect.visitor.DefaultJavaPrettyPrinter

BLOCK_COMMENT_END, BLOCK_COMMENT_START, COMMENT_STAR, env, ERROR_MESSAGE_TO_STRING, ignoreImplicit, INLINE_COMMENT_START, inlineElseIf, JAVA_FILE_EXTENSION, JAVA_MODULE_DECLARATION, JAVA_PACKAGE_DECLARATION, JAVADOC_START, LINE_SEPARATOR, LOGGER, preprocessors, sourceCompilationUnit

Constructor Summary

Constructors

Constructor and Description
SniperJavaPrettyPrinter(Environment env) Creates a new PrettyPrinter which copies origin sources and prints only changes.

Method Summary

Modifier and Type	Method and Description
void	calculate(CtCompilationUnit compilationUnit, java.util.List<CtType<?>> types) Calculates the resulting source file for a list of types.
protected ModelList<CtImport>	getImports(CtCompilationUnit compilationUnit)
static boolean	hasImplicitAncestor(CtElement el) Warning, not in the API, public for testing purposes
void	onTokenWriterWrite(TokenType tokenType, java.lang.String token, CtComment comment, java.lang.Runnable printAction) Called for each printed token
java.lang.String	printElement(CtElement element) The sniper mode only works from JavaOutputProcessor
java.lang.String	printElementSniper(CtElement element) Warning: debug and test method only, not part of the public API
java.lang.String	printTypes(CtType<?>... type) Prints the types of one compilation unit It always resets the printing context at the beginning of this process.
SniperJavaPrettyPrinter	scan(CtElement element) Called whenever DefaultJavaPrettyPrinter scans/prints an element Warning: DO not call on a cloned element.

Methods inherited from class spoon.reflect.visitor.DefaultJavaPrettyPrinter

applyPreProcessors, enter, enterCtExpression, enterCtStatement, exit, exitCtExpression, exitCtStatement, getContext, getElementPrinterHelper, getLineNumberMapping, getLineSeparator, getPreprocessors, getPrinterTokenWriter, getResult, isMinimizeRoundBrackets, prettyprint, printCompilationUnit, printModuleInfo, printPackageInfo, reset, setIgnoreImplicit, setLineSeparator, setMinimizeRoundBrackets, setPreprocessors, setPrinterTokenWriter, toString, visitCtAnnotation, visitCtAnnotationFieldAccess, visitCtAnnotationMethod, visitCtAnnotationType, visitCtAnonymousExecutable, visitCtArrayRead, visitCtArrayTypeReference, visitCtArrayWrite, visitCtAssert, visitCtAssignment, visitCtBinaryOperator, visitCtBlock, visitCtBreak, visitCtCase, visitCtCatch, visitCtCatchVariable, visitCtCatchVariableReference, visitCtClass, visitCtCodeSnippetExpression, visitCtCodeSnippetStatement, visitCtComment, visitCtCompilationUnit, visitCtConditional, visitCtConstructor, visitCtConstructorCall, visitCtContinue, visitCtDo, visitCtEnum, visitCtEnumValue, visitCtExecutableReference, visitCtExecutableReferenceExpression, visitCtField, visitCtFieldRead, visitCtFieldReference, visitCtFieldWrite, visitCtFor, visitCtForEach, visitCtIf, visitCtImport, visitCtInterface, visitCtIntersectionTypeReference, visitCtInvocation, visitCtJavaDoc, visitCtJavaDocTag, visitCtLambda, visitCtLiteral, visitCtLocalVariable, visitCtLocalVariableReference, visitCtMethod, visitCtModule, visitCtModuleReference, visitCtModuleRequirement, visitCtNewArray, visitCtNewClass, visitCtOperatorAssignment, visitCtPackage, visitCtPackageDeclaration, visitCtPackageExport, visitCtPackageReference, visitCtParameter, visitCtParameterReference, visitCtProvidedService, visitCtReturn, visitCtStatementList, visitCtSuperAccess, visitCtSwitch, visitCtSwitchExpression, visitCtSynchronized, visitCtTextBlock, visitCtThisAccess, visitCtThrow, visitCtTry, visitCtTryWithResource, visitCtTypeAccess, visitCtTypeMemberWildcardImportReference, visitCtTypeParameter, visitCtTypeParameterReference, visitCtTypeReference, visitCtUnaryOperator, visitCtUnboundVariableReference, visitCtUsedService, visitCtVariableRead, visitCtVariableWrite, visitCtWhile, visitCtWildcardReference, visitCtYieldStatement

Methods inherited from class java.lang.Object

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

Constructor Detail

SniperJavaPrettyPrinter

public SniperJavaPrettyPrinter(Environment env)

Creates a new PrettyPrinter which copies origin sources and prints only changes.

Method Detail

printTypes

public java.lang.String printTypes(CtType<?>... type)

Description copied from interface: PrettyPrinter

Prints the types of one compilation unit It always resets the printing context at the beginning of this process.

Specified by:

printTypes in interface PrettyPrinter

Overrides:

printTypes in class DefaultJavaPrettyPrinter

calculate

public void calculate(CtCompilationUnit compilationUnit,
                      java.util.List<CtType<?>> types)

Description copied from interface: PrettyPrinter

Calculates the resulting source file for a list of types. The source compilation unit is required for calculating the line numbers mapping. It always resets the printing context at the beginning of this process.

Specified by:

calculate in interface PrettyPrinter

Overrides:

calculate in class DefaultJavaPrettyPrinter

onTokenWriterWrite

public void onTokenWriterWrite(TokenType tokenType,
                               java.lang.String token,
                               CtComment comment,
                               java.lang.Runnable printAction)

Called for each printed token

Specified by:

onTokenWriterWrite in interface TokenWriterProxy.Listener

Parameters:

tokenType - the type of TokenWriter method

token - the actual token value. It may be null for some `tokenWriterMethodName`

comment - the comment when `tokenType` == `COMMENT`

printAction - the executor of the action, we are listening for. Call it send token to output

hasImplicitAncestor

public static boolean hasImplicitAncestor(CtElement el)

Warning, not in the API, public for testing purposes

printElement

public java.lang.String printElement(CtElement element)

The sniper mode only works from JavaOutputProcessor

Specified by:

printElement in interface PrettyPrinter

Overrides:

printElement in class DefaultJavaPrettyPrinter

Returns:

A string containing the pretty printed element (and descendants).

printElementSniper

public java.lang.String printElementSniper(CtElement element)

Warning: debug and test method only, not part of the public API

scan

public SniperJavaPrettyPrinter scan(CtElement element)

Called whenever DefaultJavaPrettyPrinter scans/prints an element Warning: DO not call on a cloned element. Use scanClone instead.

Overrides:

scan in class DefaultJavaPrettyPrinter

getImports

protected ModelList<CtImport> getImports(CtCompilationUnit compilationUnit)

Overrides:

getImports in class DefaultJavaPrettyPrinter