com.liferay.source.formatter

Class JavaSourceProcessor

java.lang.Object

com.liferay.source.formatter.BaseSourceProcessor

com.liferay.source.formatter.JavaSourceProcessor

All Implemented Interfaces:

SourceProcessor

Direct Known Subclasses:

GroovySourceProcessor

public class JavaSourceProcessor
extends BaseSourceProcessor

Field Summary

Fields inherited from class com.liferay.source.formatter.BaseSourceProcessor

applyLangMergerPluginPattern, attributeNamePattern, bndContentDirPattern, emptyCollectionPattern, getterUtilGetPattern, javaSourceInsideJSPTagPattern, jsonObjectPutBlockPattern, jsonObjectPutPattern, languageKeyPattern, mergeLangPattern, PORTAL_MAX_DIR_LEVEL, portalSource, principalExceptionPattern, sbAppendPattern, sbAppendWithStartingSpacePattern, sessionKeyPattern, singleLengthStringPattern, sourceFormatterArgs, stringUtilReplacePattern, taglibSessionKeyPattern

Constructor Summary

Constructors

Constructor and Description
JavaSourceProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	applyDiamondOperator(java.lang.String content)
protected java.lang.String	checkAnnotationMetaTypeProperties(java.lang.String content, java.lang.String annotation)
protected java.lang.String	checkAnnotationParameterProperties(java.lang.String content, java.lang.String annotation)
protected void	checkAnnotationParameters(java.lang.String fileName, java.lang.String javaTermName, java.lang.String annotation)
protected void	checkBndInheritAnnotationOption()
protected void	checkDeserializationSecurity(java.lang.String fileName, java.lang.String content, boolean isRunOutsidePortalExclusion)
protected void	checkFinderCacheInterfaceMethod(java.lang.String fileName, java.lang.String content)
protected void	checkLogLevel(java.lang.String content, java.lang.String fileName)
protected void	checkMissingAuthor(java.lang.String content, java.lang.String fileName, java.lang.String className)
protected void	checkPackagePath(java.lang.String content, java.lang.String fileName, java.lang.String packagePath)
protected void	checkRegexPattern(java.lang.String regexPattern, java.lang.String fileName, int lineCount)
protected void	checkSystemEventAnnotations(java.lang.String content, java.lang.String fileName)
protected void	checkXMLSecurity(java.lang.String fileName, java.lang.String content, boolean isRunOutsidePortalExclusion)
protected java.lang.String	doFormat(java.io.File file, java.lang.String fileName, java.lang.String absolutePath, java.lang.String content)
protected java.util.List<java.lang.String>	doGetFileNames()
protected java.lang.String	fixDataAccessConnection(java.lang.String className, java.lang.String content)
protected java.lang.String	fixIfClause(java.lang.String ifClause, java.lang.String line, int delta)
protected java.lang.String	fixIncorrectEmptyLineBeforeCloseCurlyBrace(java.lang.String content, java.lang.String fileName)
protected java.lang.String	fixMissingEmptyLineAfterSettingVariable(java.lang.String content)
protected java.lang.String	fixMissingEmptyLines(java.lang.String content)
protected java.lang.String	fixRedundantEmptyLines(java.lang.String content)
protected java.lang.String	fixSystemExceptions(java.lang.String content)
protected java.lang.String	formatAnnotations(java.lang.String fileName, java.lang.String javaTermName, java.lang.String content, java.lang.String indent)
protected java.lang.String	formatArray(java.lang.String content)
protected java.lang.String	formatAssertEquals(java.lang.String fileName, java.lang.String content)
protected java.lang.String	formatClassLine(java.lang.String content)
protected java.lang.String	formatDuplicateReferenceMethods(java.lang.String fileName, java.lang.String content, java.lang.String className, java.lang.String packagePath)
protected java.lang.String	formatExceptions(java.lang.String content, java.io.File file, java.lang.String packagePath, java.lang.String fileName)
protected java.lang.String	formatIfClause(java.lang.String ifClause)
protected java.lang.String	formatIfClause(java.lang.String ifClause, java.lang.String fileName, int lineCount)
protected java.lang.String	formatJava(java.lang.String fileName, java.lang.String absolutePath, java.lang.String content)
protected java.lang.String	formatModulesFile(java.lang.String fileName, java.lang.String absolutePath, java.lang.String className, java.lang.String packagePath, java.lang.String content)
protected java.lang.String	formatOSGIComponents(java.lang.String fileName, java.lang.String absolutePath, java.lang.String content, java.lang.String className, java.lang.String packagePath)
protected java.lang.String	getCombinedLinesContent(java.lang.String content, java.util.regex.Pattern pattern)
protected java.lang.String	getCombinedLinesContent(java.lang.String content, java.lang.String fileName, java.lang.String line, java.lang.String trimmedLine, int lineLength, int lineCount, java.lang.String previousLine, java.lang.String linePart, int tabDiff, boolean addToPreviousLine, boolean extraSpace, int numNextLinesRemoveLeadingTab)
protected java.lang.String	getCombinedLinesContent(java.lang.String content, java.lang.String fileName, java.lang.String absolutePath, java.lang.String line, java.lang.String trimmedLine, int lineLength, int lineCount, java.lang.String previousLine, int lineTabCount, int previousLineTabCount)
protected java.lang.String	getFormattedClassLine(java.lang.String indent, java.lang.String classLine)
protected int	getIfClauseLineBreakPos(java.lang.String line)
protected java.util.List<java.lang.String>	getImportedExceptionClassNames(com.thoughtworks.qdox.JavaDocBuilder javaDocBuilder)
java.lang.String[]	getIncludes()
protected int	getIncorrectLineBreakPos(java.lang.String line, java.lang.String previousLine)
protected java.lang.String	getModuleClassContent(java.lang.String fullClassName)
protected java.util.Map<java.lang.String,java.lang.String>	getModuleFileNamesMap()
protected java.lang.String	getModuleServicePackagePath(java.lang.String fileName)
protected java.lang.String	getModuleSuperClassContent(java.lang.String content, java.lang.String className, java.lang.String packagePath)
protected java.util.Collection<java.lang.String>	getPluginJavaFiles()
protected java.util.Collection<java.lang.String>	getPortalJavaFiles()
protected java.lang.String	getTruncateLongLinesContent(java.lang.String content, java.lang.String line, java.lang.String trimmedLine, int lineCount)
protected boolean	hasGeneratedTag(java.lang.String content)
protected boolean	isAnnotationParameter(java.lang.String content, java.lang.String line)
protected boolean	isValidJavaParameter(java.lang.String javaParameter)
protected void	postFormat()
protected void	preFormat()
protected void	setBNDInheritRequiredValue(java.lang.String fileName, boolean bndInheritRequired)
protected java.lang.String	sortExceptions(java.lang.String line)

Methods inherited from class com.liferay.source.formatter.BaseSourceProcessor

adjustLevel, checkEmptyCollection, checkGetterUtilGet, checkIfClauseParentheses, checkInefficientStringMethods, checkLanguageKeys, checkOrder, checkPrincipalException, checkPropertyUtils, checkResourceUtil, checkStringUtilReplace, checkUTF8, fixCompatClassImports, fixCopyright, fixIncorrectParameterTypeForLanguageUtil, fixSessionKey, format, format, format, formatAttributes, formatEmptyArray, formatIncorrectSyntax, formatJavaTerms, formatJSONObject, formatStringBundler, formatTagAttributeType, formatWhitespace, formatWhitespace, getAbsolutePath, getAnnotationsExclusions, getBNDFileLanguageProperties, getBNDFileLocationAndContentTuple, getCompatClassNamesMap, getContent, getCustomCopyright, getErrorMessages, getFile, getFileNames, getFileNames, getFileNames, getFileNames, getFirstSourceMismatchException, getImmutableFieldTypes, getLanguageKeys, getLeadingTabCount, getLevel, getLevel, getLevel, getLevel, getLine, getLineCount, getLineLength, getLineStartPos, getMainReleaseVersion, getModifiedFileNames, getModuleLangDirNames, getModuleLangLanguageProperties, getModuleLanguageProperties, getParameterList, getProperty, getPropertyList, getRunOutsidePortalExcludes, hasMissingParentheses, hasRedundantParentheses, hasRedundantParentheses, isAttributName, isExcludedPath, isExcludedPath, isExcludedPath, isModulesFile, printError, processErrorMessage, processFormattedFile, readXML, replacePrimitiveWrapperInstantiation, setSourceFormatterArgs, sortHTMLAttributes, splitParameters, stripQuotes, stripQuotes, stripRedundantParentheses, trimContent, trimLine

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaSourceProcessor

public JavaSourceProcessor()

Method Detail

getIncludes

public java.lang.String[] getIncludes()

applyDiamondOperator

protected java.lang.String applyDiamondOperator(java.lang.String content)

checkAnnotationMetaTypeProperties

protected java.lang.String checkAnnotationMetaTypeProperties(java.lang.String content,
                                                 java.lang.String annotation)

checkAnnotationParameterProperties

protected java.lang.String checkAnnotationParameterProperties(java.lang.String content,
                                                  java.lang.String annotation)

checkAnnotationParameters

protected void checkAnnotationParameters(java.lang.String fileName,
                             java.lang.String javaTermName,
                             java.lang.String annotation)

checkBndInheritAnnotationOption

protected void checkBndInheritAnnotationOption()

checkDeserializationSecurity

protected void checkDeserializationSecurity(java.lang.String fileName,
                                java.lang.String content,
                                boolean isRunOutsidePortalExclusion)

checkFinderCacheInterfaceMethod

protected void checkFinderCacheInterfaceMethod(java.lang.String fileName,
                                   java.lang.String content)

checkLogLevel

protected void checkLogLevel(java.lang.String content,
                 java.lang.String fileName)

checkMissingAuthor

protected void checkMissingAuthor(java.lang.String content,
                      java.lang.String fileName,
                      java.lang.String className)

checkPackagePath

protected void checkPackagePath(java.lang.String content,
                    java.lang.String fileName,
                    java.lang.String packagePath)

checkRegexPattern

protected void checkRegexPattern(java.lang.String regexPattern,
                     java.lang.String fileName,
                     int lineCount)

checkSystemEventAnnotations

protected void checkSystemEventAnnotations(java.lang.String content,
                               java.lang.String fileName)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

checkXMLSecurity

protected void checkXMLSecurity(java.lang.String fileName,
                    java.lang.String content,
                    boolean isRunOutsidePortalExclusion)

doFormat

protected java.lang.String doFormat(java.io.File file,
                        java.lang.String fileName,
                        java.lang.String absolutePath,
                        java.lang.String content)
                             throws java.lang.Exception

Specified by:

doFormat in class BaseSourceProcessor

Throws:

java.lang.Exception

doGetFileNames

protected java.util.List<java.lang.String> doGetFileNames()
                                                   throws java.lang.Exception

Specified by:

doGetFileNames in class BaseSourceProcessor

Throws:

java.lang.Exception

fixDataAccessConnection

protected java.lang.String fixDataAccessConnection(java.lang.String className,
                                       java.lang.String content)

fixIfClause

protected java.lang.String fixIfClause(java.lang.String ifClause,
                           java.lang.String line,
                           int delta)

fixIncorrectEmptyLineBeforeCloseCurlyBrace

protected java.lang.String fixIncorrectEmptyLineBeforeCloseCurlyBrace(java.lang.String content,
                                                          java.lang.String fileName)

fixMissingEmptyLineAfterSettingVariable

protected java.lang.String fixMissingEmptyLineAfterSettingVariable(java.lang.String content)

fixMissingEmptyLines

protected java.lang.String fixMissingEmptyLines(java.lang.String content)

fixRedundantEmptyLines

protected java.lang.String fixRedundantEmptyLines(java.lang.String content)

fixSystemExceptions

protected java.lang.String fixSystemExceptions(java.lang.String content)

formatAnnotations

protected java.lang.String formatAnnotations(java.lang.String fileName,
                                 java.lang.String javaTermName,
                                 java.lang.String content,
                                 java.lang.String indent)
                                      throws java.io.IOException

Throws:

java.io.IOException

formatArray

protected java.lang.String formatArray(java.lang.String content)

formatAssertEquals

protected java.lang.String formatAssertEquals(java.lang.String fileName,
                                  java.lang.String content)

formatClassLine

protected java.lang.String formatClassLine(java.lang.String content)

formatDuplicateReferenceMethods

protected java.lang.String formatDuplicateReferenceMethods(java.lang.String fileName,
                                               java.lang.String content,
                                               java.lang.String className,
                                               java.lang.String packagePath)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

formatExceptions

protected java.lang.String formatExceptions(java.lang.String content,
                                java.io.File file,
                                java.lang.String packagePath,
                                java.lang.String fileName)
                                     throws java.io.IOException

Throws:

java.io.IOException

formatIfClause

protected java.lang.String formatIfClause(java.lang.String ifClause)
                                   throws java.io.IOException

Throws:

java.io.IOException

formatIfClause

protected java.lang.String formatIfClause(java.lang.String ifClause,
                              java.lang.String fileName,
                              int lineCount)
                                   throws java.io.IOException

Throws:

java.io.IOException

formatJava

protected java.lang.String formatJava(java.lang.String fileName,
                          java.lang.String absolutePath,
                          java.lang.String content)
                               throws java.lang.Exception

Throws:

java.lang.Exception

formatModulesFile

protected java.lang.String formatModulesFile(java.lang.String fileName,
                                 java.lang.String absolutePath,
                                 java.lang.String className,
                                 java.lang.String packagePath,
                                 java.lang.String content)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

formatOSGIComponents

protected java.lang.String formatOSGIComponents(java.lang.String fileName,
                                    java.lang.String absolutePath,
                                    java.lang.String content,
                                    java.lang.String className,
                                    java.lang.String packagePath)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getCombinedLinesContent

protected java.lang.String getCombinedLinesContent(java.lang.String content,
                                       java.util.regex.Pattern pattern)

getCombinedLinesContent

protected java.lang.String getCombinedLinesContent(java.lang.String content,
                                       java.lang.String fileName,
                                       java.lang.String line,
                                       java.lang.String trimmedLine,
                                       int lineLength,
                                       int lineCount,
                                       java.lang.String previousLine,
                                       java.lang.String linePart,
                                       int tabDiff,
                                       boolean addToPreviousLine,
                                       boolean extraSpace,
                                       int numNextLinesRemoveLeadingTab)

getCombinedLinesContent

protected java.lang.String getCombinedLinesContent(java.lang.String content,
                                       java.lang.String fileName,
                                       java.lang.String absolutePath,
                                       java.lang.String line,
                                       java.lang.String trimmedLine,
                                       int lineLength,
                                       int lineCount,
                                       java.lang.String previousLine,
                                       int lineTabCount,
                                       int previousLineTabCount)

getFormattedClassLine

protected java.lang.String getFormattedClassLine(java.lang.String indent,
                                     java.lang.String classLine)

getIfClauseLineBreakPos

protected int getIfClauseLineBreakPos(java.lang.String line)

getImportedExceptionClassNames

protected java.util.List<java.lang.String> getImportedExceptionClassNames(com.thoughtworks.qdox.JavaDocBuilder javaDocBuilder)

getIncorrectLineBreakPos

protected int getIncorrectLineBreakPos(java.lang.String line,
                           java.lang.String previousLine)

getModuleClassContent

protected java.lang.String getModuleClassContent(java.lang.String fullClassName)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getModuleFileNamesMap

protected java.util.Map<java.lang.String,java.lang.String> getModuleFileNamesMap()
                                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getModuleServicePackagePath

protected java.lang.String getModuleServicePackagePath(java.lang.String fileName)

getModuleSuperClassContent

protected java.lang.String getModuleSuperClassContent(java.lang.String content,
                                          java.lang.String className,
                                          java.lang.String packagePath)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getPluginJavaFiles

protected java.util.Collection<java.lang.String> getPluginJavaFiles()
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

getPortalJavaFiles

protected java.util.Collection<java.lang.String> getPortalJavaFiles()
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

getTruncateLongLinesContent

protected java.lang.String getTruncateLongLinesContent(java.lang.String content,
                                           java.lang.String line,
                                           java.lang.String trimmedLine,
                                           int lineCount)

hasGeneratedTag

protected boolean hasGeneratedTag(java.lang.String content)

isAnnotationParameter

protected boolean isAnnotationParameter(java.lang.String content,
                            java.lang.String line)

isValidJavaParameter

protected boolean isValidJavaParameter(java.lang.String javaParameter)

postFormat

protected void postFormat()
                   throws java.lang.Exception

Overrides:

postFormat in class BaseSourceProcessor

Throws:

java.lang.Exception

preFormat

protected void preFormat()

Overrides:

preFormat in class BaseSourceProcessor

setBNDInheritRequiredValue

protected void setBNDInheritRequiredValue(java.lang.String fileName,
                              boolean bndInheritRequired)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

sortExceptions

protected java.lang.String sortExceptions(java.lang.String line)