com.liferay.source.formatter

Class BaseSourceProcessor

java.lang.Object

com.liferay.source.formatter.BaseSourceProcessor

All Implemented Interfaces:

SourceProcessor

Direct Known Subclasses:

CSSSourceProcessor, FTLSourceProcessor, JavaSourceProcessor, JSPSourceProcessor, JSSourceProcessor, PropertiesSourceProcessor, SHSourceProcessor, SQLSourceProcessor, TLDSourceProcessor, XMLSourceProcessor

public abstract class BaseSourceProcessor
extends java.lang.Object
implements SourceProcessor

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.regex.Pattern	attributeNamePattern
protected static java.util.regex.Pattern	bndContentDirPattern
protected static java.util.regex.Pattern	emptyCollectionPattern
protected static java.util.regex.Pattern	javaSourceInsideJSPTagPattern
protected static java.util.regex.Pattern	languageKeyPattern
static int	PORTAL_MAX_DIR_LEVEL
protected static boolean	portalSource
protected static java.util.regex.Pattern	principalExceptionPattern
protected static java.util.regex.Pattern	sessionKeyPattern
protected SourceFormatterArgs	sourceFormatterArgs
protected static java.util.regex.Pattern	taglibSessionKeyPattern

Constructor Summary

Constructors

Constructor and Description
BaseSourceProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkEmptyCollection(java.lang.String line, java.lang.String fileName, int lineCount)
protected void	checkIfClauseParentheses(java.lang.String ifClause, java.lang.String fileName, int lineCount)
protected void	checkInefficientStringMethods(java.lang.String line, java.lang.String fileName, java.lang.String absolutePath, int lineCount)
protected void	checkLanguageKeys(java.lang.String fileName, java.lang.String content, java.util.regex.Pattern pattern)
protected java.lang.String	checkPrincipalException(java.lang.String content)
protected void	checkResourceUtil(java.lang.String line, java.lang.String fileName, int lineCount)
protected void	checkStringBundler(java.lang.String line, java.lang.String fileName, int lineCount)
protected abstract java.lang.String	doFormat(java.io.File file, java.lang.String fileName, java.lang.String absolutePath, java.lang.String content)
protected abstract java.util.List<java.lang.String>	doGetFileNames()
protected java.lang.String	fixCompatClassImports(java.lang.String absolutePath, java.lang.String content)
protected java.lang.String	fixCopyright(java.lang.String content, java.lang.String absolutePath, java.lang.String fileName)
protected java.lang.String	fixIncorrectParameterTypeForLanguageUtil(java.lang.String content, boolean autoFix, java.lang.String fileName)
protected java.lang.String	fixSessionKey(java.lang.String fileName, java.lang.String content, java.util.regex.Pattern pattern)
void	format()
protected java.lang.String	format(java.io.File file, java.lang.String fileName, java.lang.String absolutePath, java.lang.String content)
protected void	format(java.lang.String fileName)
protected java.lang.String	formatIncorrectSyntax(java.lang.String line, java.lang.String incorrectSyntax, java.lang.String correctSyntax, boolean lineStart)
protected java.lang.String	formatJavaTerms(java.lang.String javaClassName, java.lang.String packagePath, java.io.File file, java.lang.String fileName, java.lang.String absolutePath, java.lang.String content, java.lang.String javaClassContent, int javaClassLineCount, java.util.List<java.lang.String> checkJavaFieldTypesExclusionFiles, java.util.List<java.lang.String> javaTermAccessLevelModifierExclusionFiles, java.util.List<java.lang.String> javaTermSortExclusionFiles, java.util.List<java.lang.String> testAnnotationsExclusionFiles)
protected java.lang.String	formatTagAttributeType(java.lang.String line, java.lang.String tag, java.lang.String attributeAndValue)
protected java.lang.String	formatWhitespace(java.lang.String line, java.lang.String linePart)
protected java.lang.String	formatWhitespace(java.lang.String line, java.lang.String trimmedLine, boolean javaSource)
protected java.lang.String	getAbsolutePath(java.io.File file)
protected java.util.Set<java.lang.String>	getAnnotationsExclusions()
protected java.util.Properties	getBNDFileLanguageProperties(java.lang.String fileName)
protected java.util.Map<java.lang.String,java.lang.String>	getCompatClassNamesMap()
protected java.lang.String	getContent(java.lang.String fileName, int level)
protected java.lang.String	getCustomCopyright(java.lang.String absolutePath)
java.util.List<java.lang.String>	getErrorMessages()
protected java.io.File	getFile(java.lang.String fileName, int level)
java.util.List<java.lang.String>	getFileNames()
protected java.util.List<java.lang.String>	getFileNames(java.lang.String[] excludes, java.lang.String[] includes)
protected java.util.List<java.lang.String>	getFileNames(java.lang.String basedir, java.util.List<java.lang.String> recentChangesFileNames, java.lang.String[] excludes, java.lang.String[] includes)
protected java.util.List<java.lang.String>	getFileNames(java.lang.String basedir, java.lang.String[] excludes, java.lang.String[] includes)
SourceMismatchException	getFirstSourceMismatchException()
protected java.util.Set<java.lang.String>	getImmutableFieldTypes()
protected java.lang.String[]	getLanguageKeys(java.util.regex.Matcher matcher)
protected static int	getLeadingTabCount(java.lang.String line)
protected java.lang.String	getMainReleaseVersion()
java.util.List<java.lang.String>	getModifiedFileNames()
protected java.util.Properties	getModuleLanguageProperties(java.lang.String fileName)
protected java.lang.String	getProperty(java.lang.String key)
protected java.util.List<java.lang.String>	getPropertyList(java.lang.String key)
protected java.util.List<java.lang.String>	getRunOutsidePortalExclusionPaths()
protected boolean	hasMissingParentheses(java.lang.String s)
protected boolean	hasRedundantParentheses(java.lang.String s)
protected boolean	hasRedundantParentheses(java.lang.String s, java.lang.String operator1, java.lang.String operator2)
protected boolean	isAttributName(java.lang.String attributeName)
protected static boolean	isExcludedFile(java.util.List<java.lang.String> exclusionFiles, java.lang.String absolutePath)
protected static boolean	isExcludedFile(java.util.List<java.lang.String> exclusionFiles, java.lang.String absolutePath, int lineCount)
protected static boolean	isExcludedFile(java.util.List<java.lang.String> exclusionFiles, java.lang.String absolutePath, int lineCount, java.lang.String javaTermName)
protected static boolean	isExcludedPath(java.util.List<java.lang.String> exclusionPaths, java.lang.String absolutePath)
protected boolean	isModulesFile(java.lang.String absolutePath)
protected void	postFormat()
protected void	processErrorMessage(java.lang.String fileName, java.lang.String message)
protected void	processFormattedFile(java.io.File file, java.lang.String fileName, java.lang.String content, java.lang.String newContent)
protected java.lang.String	replacePrimitiveWrapperInstantiation(java.lang.String line)
void	setSourceFormatterArgs(SourceFormatterArgs sourceFormatterArgs)
protected java.lang.String	sortAttributes(java.lang.String fileName, java.lang.String line, int lineCount, boolean allowApostropheDelimeter)
protected java.lang.String	sortHTMLAttributes(java.lang.String line, java.lang.String value, java.lang.String attributeAndValue)
protected static java.lang.String	stripQuotes(java.lang.String s, char delimeter)
protected java.lang.String	stripRedundantParentheses(java.lang.String s)
protected java.lang.String	trimContent(java.lang.String content, boolean allowLeadingSpaces)
protected java.lang.String	trimLine(java.lang.String line, boolean allowLeadingSpaces)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.source.formatter.SourceProcessor

getIncludes

Field Detail

PORTAL_MAX_DIR_LEVEL

public static final int PORTAL_MAX_DIR_LEVEL

See Also:

Constant Field Values

attributeNamePattern

protected static java.util.regex.Pattern attributeNamePattern

bndContentDirPattern

protected static java.util.regex.Pattern bndContentDirPattern

emptyCollectionPattern

protected static java.util.regex.Pattern emptyCollectionPattern

javaSourceInsideJSPTagPattern

protected static java.util.regex.Pattern javaSourceInsideJSPTagPattern

languageKeyPattern

protected static java.util.regex.Pattern languageKeyPattern

portalSource

protected static boolean portalSource

principalExceptionPattern

protected static java.util.regex.Pattern principalExceptionPattern

sessionKeyPattern

protected static java.util.regex.Pattern sessionKeyPattern

taglibSessionKeyPattern

protected static java.util.regex.Pattern taglibSessionKeyPattern

sourceFormatterArgs

protected SourceFormatterArgs sourceFormatterArgs

Constructor Detail

BaseSourceProcessor

public BaseSourceProcessor()

Method Detail

format

public final void format()
                  throws java.lang.Exception

Specified by:

format in interface SourceProcessor

Throws:

java.lang.Exception

getErrorMessages

public java.util.List<java.lang.String> getErrorMessages()

Specified by:

getErrorMessages in interface SourceProcessor

getFileNames

public final java.util.List<java.lang.String> getFileNames()
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getFirstSourceMismatchException

public SourceMismatchException getFirstSourceMismatchException()

Specified by:

getFirstSourceMismatchException in interface SourceProcessor

getModifiedFileNames

public java.util.List<java.lang.String> getModifiedFileNames()

Specified by:

getModifiedFileNames in interface SourceProcessor

setSourceFormatterArgs

public void setSourceFormatterArgs(SourceFormatterArgs sourceFormatterArgs)

Specified by:

setSourceFormatterArgs in interface SourceProcessor

getLeadingTabCount

protected static int getLeadingTabCount(java.lang.String line)

isExcludedFile

protected static boolean isExcludedFile(java.util.List<java.lang.String> exclusionFiles,
                     java.lang.String absolutePath)

isExcludedFile

protected static boolean isExcludedFile(java.util.List<java.lang.String> exclusionFiles,
                     java.lang.String absolutePath,
                     int lineCount)

isExcludedFile

protected static boolean isExcludedFile(java.util.List<java.lang.String> exclusionFiles,
                     java.lang.String absolutePath,
                     int lineCount,
                     java.lang.String javaTermName)

isExcludedPath

protected static boolean isExcludedPath(java.util.List<java.lang.String> exclusionPaths,
                     java.lang.String absolutePath)

stripQuotes

protected static java.lang.String stripQuotes(java.lang.String s,
                           char delimeter)

checkEmptyCollection

protected void checkEmptyCollection(java.lang.String line,
                        java.lang.String fileName,
                        int lineCount)

checkIfClauseParentheses

protected void checkIfClauseParentheses(java.lang.String ifClause,
                            java.lang.String fileName,
                            int lineCount)

checkInefficientStringMethods

protected void checkInefficientStringMethods(java.lang.String line,
                                 java.lang.String fileName,
                                 java.lang.String absolutePath,
                                 int lineCount)

checkLanguageKeys

protected void checkLanguageKeys(java.lang.String fileName,
                     java.lang.String content,
                     java.util.regex.Pattern pattern)
                          throws java.lang.Exception

Throws:

java.lang.Exception

checkPrincipalException

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

checkResourceUtil

protected void checkResourceUtil(java.lang.String line,
                     java.lang.String fileName,
                     int lineCount)

checkStringBundler

protected void checkStringBundler(java.lang.String line,
                      java.lang.String fileName,
                      int lineCount)

doFormat

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

Throws:

java.lang.Exception

doGetFileNames

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

Throws:

java.lang.Exception

fixCompatClassImports

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

Throws:

java.lang.Exception

fixCopyright

protected java.lang.String fixCopyright(java.lang.String content,
                            java.lang.String absolutePath,
                            java.lang.String fileName)
                                 throws java.io.IOException

Throws:

java.io.IOException

fixIncorrectParameterTypeForLanguageUtil

protected java.lang.String fixIncorrectParameterTypeForLanguageUtil(java.lang.String content,
                                                        boolean autoFix,
                                                        java.lang.String fileName)

fixSessionKey

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

format

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

Throws:

java.lang.Exception

format

protected final void format(java.lang.String fileName)
                     throws java.lang.Exception

Throws:

java.lang.Exception

formatIncorrectSyntax

protected java.lang.String formatIncorrectSyntax(java.lang.String line,
                                     java.lang.String incorrectSyntax,
                                     java.lang.String correctSyntax,
                                     boolean lineStart)

formatJavaTerms

protected java.lang.String formatJavaTerms(java.lang.String javaClassName,
                               java.lang.String packagePath,
                               java.io.File file,
                               java.lang.String fileName,
                               java.lang.String absolutePath,
                               java.lang.String content,
                               java.lang.String javaClassContent,
                               int javaClassLineCount,
                               java.util.List<java.lang.String> checkJavaFieldTypesExclusionFiles,
                               java.util.List<java.lang.String> javaTermAccessLevelModifierExclusionFiles,
                               java.util.List<java.lang.String> javaTermSortExclusionFiles,
                               java.util.List<java.lang.String> testAnnotationsExclusionFiles)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

formatTagAttributeType

protected java.lang.String formatTagAttributeType(java.lang.String line,
                                      java.lang.String tag,
                                      java.lang.String attributeAndValue)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

formatWhitespace

protected java.lang.String formatWhitespace(java.lang.String line,
                                java.lang.String linePart)

formatWhitespace

protected java.lang.String formatWhitespace(java.lang.String line,
                                java.lang.String trimmedLine,
                                boolean javaSource)

getAbsolutePath

protected java.lang.String getAbsolutePath(java.io.File file)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getAnnotationsExclusions

protected java.util.Set<java.lang.String> getAnnotationsExclusions()

getBNDFileLanguageProperties

protected java.util.Properties getBNDFileLanguageProperties(java.lang.String fileName)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getCompatClassNamesMap

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

Throws:

java.lang.Exception

getContent

protected java.lang.String getContent(java.lang.String fileName,
                          int level)
                               throws java.io.IOException

Throws:

java.io.IOException

getCustomCopyright

protected java.lang.String getCustomCopyright(java.lang.String absolutePath)
                                       throws java.io.IOException

Throws:

java.io.IOException

getFile

protected java.io.File getFile(java.lang.String fileName,
                   int level)

getFileNames

protected java.util.List<java.lang.String> getFileNames(java.lang.String basedir,
                                            java.util.List<java.lang.String> recentChangesFileNames,
                                            java.lang.String[] excludes,
                                            java.lang.String[] includes)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getFileNames

protected java.util.List<java.lang.String> getFileNames(java.lang.String basedir,
                                            java.lang.String[] excludes,
                                            java.lang.String[] includes)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getFileNames

protected java.util.List<java.lang.String> getFileNames(java.lang.String[] excludes,
                                            java.lang.String[] includes)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getImmutableFieldTypes

protected java.util.Set<java.lang.String> getImmutableFieldTypes()

getLanguageKeys

protected java.lang.String[] getLanguageKeys(java.util.regex.Matcher matcher)

getMainReleaseVersion

protected java.lang.String getMainReleaseVersion()

getModuleLanguageProperties

protected java.util.Properties getModuleLanguageProperties(java.lang.String fileName)

getProperty

protected java.lang.String getProperty(java.lang.String key)

getPropertyList

protected java.util.List<java.lang.String> getPropertyList(java.lang.String key)

getRunOutsidePortalExclusionPaths

protected java.util.List<java.lang.String> getRunOutsidePortalExclusionPaths()

hasMissingParentheses

protected boolean hasMissingParentheses(java.lang.String s)

hasRedundantParentheses

protected boolean hasRedundantParentheses(java.lang.String s)

hasRedundantParentheses

protected boolean hasRedundantParentheses(java.lang.String s,
                              java.lang.String operator1,
                              java.lang.String operator2)

isAttributName

protected boolean isAttributName(java.lang.String attributeName)

isModulesFile

protected boolean isModulesFile(java.lang.String absolutePath)

postFormat

protected void postFormat()
                   throws java.lang.Exception

Throws:

java.lang.Exception

processErrorMessage

protected void processErrorMessage(java.lang.String fileName,
                       java.lang.String message)

processFormattedFile

protected void processFormattedFile(java.io.File file,
                        java.lang.String fileName,
                        java.lang.String content,
                        java.lang.String newContent)
                             throws java.io.IOException

Throws:

java.io.IOException

replacePrimitiveWrapperInstantiation

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

sortAttributes

protected java.lang.String sortAttributes(java.lang.String fileName,
                              java.lang.String line,
                              int lineCount,
                              boolean allowApostropheDelimeter)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

sortHTMLAttributes

protected java.lang.String sortHTMLAttributes(java.lang.String line,
                                  java.lang.String value,
                                  java.lang.String attributeAndValue)

stripRedundantParentheses

protected java.lang.String stripRedundantParentheses(java.lang.String s)

trimContent

protected java.lang.String trimContent(java.lang.String content,
                           boolean allowLeadingSpaces)
                                throws java.io.IOException

Throws:

java.io.IOException

trimLine

protected java.lang.String trimLine(java.lang.String line,
                        boolean allowLeadingSpaces)