com.liferay.portal.tools.sourceformatter

Class JavaSourceProcessor

java.lang.Object

com.liferay.portal.tools.sourceformatter.BaseSourceProcessor

com.liferay.portal.tools.sourceformatter.JavaSourceProcessor

All Implemented Interfaces:

SourceProcessor

public class JavaSourceProcessor
extends BaseSourceProcessor

Author:

Hugo Huijser

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_CLASS_PRIVATE
static int	TYPE_CLASS_PRIVATE_STATIC
static int	TYPE_CLASS_PROTECTED
static int	TYPE_CLASS_PROTECTED_STATIC
static int	TYPE_CLASS_PUBLIC
static int	TYPE_CLASS_PUBLIC_STATIC
static int[]	TYPE_CONSTRUCTOR
static int	TYPE_CONSTRUCTOR_PRIVATE
static int	TYPE_CONSTRUCTOR_PROTECTED
static int	TYPE_CONSTRUCTOR_PUBLIC
static int[]	TYPE_METHOD
static int	TYPE_METHOD_PRIVATE
static int	TYPE_METHOD_PRIVATE_STATIC
static int	TYPE_METHOD_PROTECTED
static int	TYPE_METHOD_PROTECTED_STATIC
static int	TYPE_METHOD_PUBLIC
static int	TYPE_METHOD_PUBLIC_STATIC
static int[]	TYPE_VARIABLE
static int	TYPE_VARIABLE_PRIVATE
static int	TYPE_VARIABLE_PRIVATE_STATIC
static int	TYPE_VARIABLE_PRIVATE_STATIC_FINAL
static int	TYPE_VARIABLE_PROTECTED
static int	TYPE_VARIABLE_PROTECTED_STATIC
static int	TYPE_VARIABLE_PROTECTED_STATIC_FINAL
static int	TYPE_VARIABLE_PUBLIC
static int	TYPE_VARIABLE_PUBLIC_STATIC
static int	TYPE_VARIABLE_PUBLIC_STATIC_FINAL

Fields inherited from class com.liferay.portal.tools.sourceformatter.BaseSourceProcessor

BASEDIR, fileUtil, languageKeyPattern, MAIN_RELEASE_VERSION_6_1_0, MAIN_RELEASE_VERSION_6_2_0, mainReleaseVersion, portalSource, saxReaderUtil, sessionKeyPattern, sourceFormatterHelper, taglibSessionKeyPattern

Constructor Summary

Constructors

Constructor and Description
JavaSourceProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	addParameterTypes(java.lang.String line, java.util.List<java.lang.String> parameterTypes)
protected void	checkAnnotationForMethod(JavaTerm javaTerm, java.lang.String annotation, java.lang.String requiredMethodNameRegex, int requiredMethodType, java.lang.String fileName)
protected java.lang.String	checkIfClause(java.lang.String ifClause, java.lang.String fileName, int lineCount)
protected java.lang.String	checkIfClauseTabsAndSpaces(java.lang.String ifClause)
protected void	checkLogLevel(java.lang.String content, java.lang.String fileName, java.lang.String logLevel)
protected void	checkTestAnnotations(JavaTerm javaTerm, java.lang.String fileName)
protected void	checkUnprocessedExceptions(java.lang.String content, java.io.File file, java.lang.String packagePath, java.lang.String fileName)
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	fixJavaTermsDividers(java.lang.String fileName, java.lang.String content, java.util.Set<JavaTerm> javaTerms)
protected void	format()
protected java.lang.String	format(java.lang.String fileName)
protected java.lang.String	formatAnnotations(java.lang.String fileName, java.lang.String content, java.util.Set<JavaTerm> javaTerms)
protected java.lang.String	formatJava(java.lang.String fileName, java.lang.String content)
protected java.lang.String	getClassName(java.lang.String line)
protected com.liferay.portal.kernel.util.Tuple	getCombinedLines(java.lang.String line, java.lang.String previousLine, int lineTabCount, int previousLineTabCount)
protected java.lang.String	getConstructorOrMethodName(java.lang.String line, int pos)
protected java.util.List<java.lang.String>	getImportedExceptionClassNames(com.thoughtworks.qdox.JavaDocBuilder javaDocBuilder)
protected com.liferay.portal.kernel.util.Tuple	getJavaTermTuple(java.lang.String line, java.lang.String content, int index, int numLines, int maxLines)
protected int	getLeadingTabCount(java.lang.String line)
protected int	getLineLength(java.lang.String line)
protected java.util.Collection<java.lang.String>	getPluginJavaFiles()
protected java.util.Collection<java.lang.String>	getPortalJavaFiles()
protected java.lang.String	getVariableName(java.lang.String line)
protected boolean	hasAnnotationCommentOrJavadoc(java.lang.String s)
protected boolean	isGenerated(java.lang.String content)
protected static boolean	isInJavaTermTypeGroup(int javaTermType, int[] javaTermTypeGroup)
protected boolean	isValidJavaParameter(java.lang.String javaParameter)
protected java.lang.String	sortExceptions(java.lang.String line)
protected java.lang.String	sortJavaTerms(java.lang.String fileName, java.lang.String content, java.util.Set<JavaTerm> javaTerms)
static java.lang.String	stripJavaImports(java.lang.String content, java.lang.String packageDir, java.lang.String className)

Methods inherited from class com.liferay.portal.tools.sourceformatter.BaseSourceProcessor

checkIfClauseParentheses, checkInefficientStringMethods, checkLanguageKeys, checkStringBundler, fixCompatClassImports, fixCopyright, fixSessionKey, format, format, formatImports, getCompatClassNamesMap, getCopyright, getCustomCopyright, getErrorMessages, getExclusionsProperties, getFileNames, getFileNames, getLanguageKeys, getOldCopyright, hasMissingParentheses, hasRedundantParentheses, isAutoFix, processErrorMessage, replacePrimitiveWrapperInstantiation, stripQuotes, stripRedundantParentheses, stripTopLevelDirectories, trimContent, trimLine

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_CLASS_PRIVATE

public static final int TYPE_CLASS_PRIVATE

See Also:

Constant Field Values

TYPE_CLASS_PRIVATE_STATIC

public static final int TYPE_CLASS_PRIVATE_STATIC

See Also:

Constant Field Values

TYPE_CLASS_PROTECTED

public static final int TYPE_CLASS_PROTECTED

See Also:

Constant Field Values

TYPE_CLASS_PROTECTED_STATIC

public static final int TYPE_CLASS_PROTECTED_STATIC

See Also:

Constant Field Values

TYPE_CLASS_PUBLIC

public static final int TYPE_CLASS_PUBLIC

See Also:

Constant Field Values

TYPE_CLASS_PUBLIC_STATIC

public static final int TYPE_CLASS_PUBLIC_STATIC

See Also:

Constant Field Values

TYPE_CONSTRUCTOR

public static final int[] TYPE_CONSTRUCTOR

TYPE_CONSTRUCTOR_PRIVATE

public static final int TYPE_CONSTRUCTOR_PRIVATE

See Also:

Constant Field Values

TYPE_CONSTRUCTOR_PROTECTED

public static final int TYPE_CONSTRUCTOR_PROTECTED

See Also:

Constant Field Values

TYPE_CONSTRUCTOR_PUBLIC

public static final int TYPE_CONSTRUCTOR_PUBLIC

See Also:

Constant Field Values

TYPE_METHOD

public static final int[] TYPE_METHOD

TYPE_METHOD_PRIVATE

public static final int TYPE_METHOD_PRIVATE

See Also:

Constant Field Values

TYPE_METHOD_PRIVATE_STATIC

public static final int TYPE_METHOD_PRIVATE_STATIC

See Also:

Constant Field Values

TYPE_METHOD_PROTECTED

public static final int TYPE_METHOD_PROTECTED

See Also:

Constant Field Values

TYPE_METHOD_PROTECTED_STATIC

public static final int TYPE_METHOD_PROTECTED_STATIC

See Also:

Constant Field Values

TYPE_METHOD_PUBLIC

public static final int TYPE_METHOD_PUBLIC

See Also:

Constant Field Values

TYPE_METHOD_PUBLIC_STATIC

public static final int TYPE_METHOD_PUBLIC_STATIC

See Also:

Constant Field Values

TYPE_VARIABLE

public static final int[] TYPE_VARIABLE

TYPE_VARIABLE_PRIVATE

public static final int TYPE_VARIABLE_PRIVATE

See Also:

Constant Field Values

TYPE_VARIABLE_PRIVATE_STATIC

public static final int TYPE_VARIABLE_PRIVATE_STATIC

See Also:

Constant Field Values

TYPE_VARIABLE_PRIVATE_STATIC_FINAL

public static final int TYPE_VARIABLE_PRIVATE_STATIC_FINAL

See Also:

Constant Field Values

TYPE_VARIABLE_PROTECTED

public static final int TYPE_VARIABLE_PROTECTED

See Also:

Constant Field Values

TYPE_VARIABLE_PROTECTED_STATIC

public static final int TYPE_VARIABLE_PROTECTED_STATIC

See Also:

Constant Field Values

TYPE_VARIABLE_PROTECTED_STATIC_FINAL

public static final int TYPE_VARIABLE_PROTECTED_STATIC_FINAL

See Also:

Constant Field Values

TYPE_VARIABLE_PUBLIC

public static final int TYPE_VARIABLE_PUBLIC

See Also:

Constant Field Values

TYPE_VARIABLE_PUBLIC_STATIC

public static final int TYPE_VARIABLE_PUBLIC_STATIC

See Also:

Constant Field Values

TYPE_VARIABLE_PUBLIC_STATIC_FINAL

public static final int TYPE_VARIABLE_PUBLIC_STATIC_FINAL

See Also:

Constant Field Values

Constructor Detail

JavaSourceProcessor

public JavaSourceProcessor()

Method Detail

stripJavaImports

public static java.lang.String stripJavaImports(java.lang.String content,
                                java.lang.String packageDir,
                                java.lang.String className)
                                         throws java.io.IOException

Throws:

java.io.IOException

isInJavaTermTypeGroup

protected static boolean isInJavaTermTypeGroup(int javaTermType,
                            int[] javaTermTypeGroup)

addParameterTypes

protected java.util.List<java.lang.String> addParameterTypes(java.lang.String line,
                                                 java.util.List<java.lang.String> parameterTypes)

checkAnnotationForMethod

protected void checkAnnotationForMethod(JavaTerm javaTerm,
                            java.lang.String annotation,
                            java.lang.String requiredMethodNameRegex,
                            int requiredMethodType,
                            java.lang.String fileName)

checkIfClause

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

Throws:

java.io.IOException

checkIfClauseTabsAndSpaces

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

Throws:

java.io.IOException

checkLogLevel

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

checkTestAnnotations

protected void checkTestAnnotations(JavaTerm javaTerm,
                        java.lang.String fileName)

checkUnprocessedExceptions

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

Throws:

java.io.IOException

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)

fixJavaTermsDividers

protected java.lang.String fixJavaTermsDividers(java.lang.String fileName,
                                    java.lang.String content,
                                    java.util.Set<JavaTerm> javaTerms)

format

protected void format()
               throws java.lang.Exception

Specified by:

format in class BaseSourceProcessor

Throws:

java.lang.Exception

format

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

Overrides:

format in class BaseSourceProcessor

Throws:

java.lang.Exception

formatAnnotations

protected java.lang.String formatAnnotations(java.lang.String fileName,
                                 java.lang.String content,
                                 java.util.Set<JavaTerm> javaTerms)
                                      throws java.io.IOException

Throws:

java.io.IOException

formatJava

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

Throws:

java.io.IOException

getClassName

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

getCombinedLines

protected com.liferay.portal.kernel.util.Tuple getCombinedLines(java.lang.String line,
                                                    java.lang.String previousLine,
                                                    int lineTabCount,
                                                    int previousLineTabCount)

getConstructorOrMethodName

protected java.lang.String getConstructorOrMethodName(java.lang.String line,
                                          int pos)

getImportedExceptionClassNames

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

getJavaTermTuple

protected com.liferay.portal.kernel.util.Tuple getJavaTermTuple(java.lang.String line,
                                                    java.lang.String content,
                                                    int index,
                                                    int numLines,
                                                    int maxLines)

getLeadingTabCount

protected int getLeadingTabCount(java.lang.String line)

getLineLength

protected int getLineLength(java.lang.String line)

getPluginJavaFiles

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

getPortalJavaFiles

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

getVariableName

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

hasAnnotationCommentOrJavadoc

protected boolean hasAnnotationCommentOrJavadoc(java.lang.String s)

isGenerated

protected boolean isGenerated(java.lang.String content)

isValidJavaParameter

protected boolean isValidJavaParameter(java.lang.String javaParameter)

sortExceptions

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

sortJavaTerms

protected java.lang.String sortJavaTerms(java.lang.String fileName,
                             java.lang.String content,
                             java.util.Set<JavaTerm> javaTerms)