app.myoss.cloud.code.format.eclipse

Class JavaCodeFormatter

java.lang.Object

app.myoss.cloud.code.format.eclipse.JavaCodeFormatter

public class JavaCodeFormatter
extends Object

Java代码格式化工具 https://github.com/krasa/EclipseCodeFormatter

Since:

2018年7月17日 下午11:11:06

Author:

Jerry.Chen

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jdt.internal.formatter.DefaultCodeFormatter	defaultCodeFormatter
protected ImportsSorter	importsSorter
static String	JAVA_VERSION 当前项目使用的 Java 版本
static Pattern	TRAILING_SPACES 匹配行尾空格

Constructor Summary

Constructors

Constructor and Description
JavaCodeFormatter(ImportsSorter importsSorter) Java代码格式化工具，格式化规则使用
JavaCodeFormatter(Properties properties, ImportsSorter importsSorter) Java代码格式化工具
JavaCodeFormatter(String formatConfigFile, String formatConfigFileProfile, ImportsSorter importsSorter) Java代码格式化工具
JavaCodeFormatter(URL formatConfigFile, String formatConfigFileProfile, ImportsSorter importsSorter) Java代码格式化工具

Method Summary

Modifier and Type	Method and Description
List<String>	formatDirectory(String directoryPath) 格式化 Java 代码
boolean	formatFile(String filePath) 格式化 Java 代码
String	formatText(StringBuilder fileContent) 格式化 Java 代码

Methods inherited from class java.lang.Object

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

Field Detail

TRAILING_SPACES

public static final Pattern TRAILING_SPACES

匹配行尾空格

JAVA_VERSION

public static final String JAVA_VERSION

当前项目使用的 Java 版本

defaultCodeFormatter

protected org.eclipse.jdt.internal.formatter.DefaultCodeFormatter defaultCodeFormatter

importsSorter

protected ImportsSorter importsSorter

Constructor Detail

JavaCodeFormatter

public JavaCodeFormatter(Properties properties,
                         ImportsSorter importsSorter)

Java代码格式化工具

Parameters:

properties - EclipseCodeFormatter 格式化规则

importsSorter - Java import代码格式化工具

JavaCodeFormatter

public JavaCodeFormatter(URL formatConfigFile,
                         String formatConfigFileProfile,
                         ImportsSorter importsSorter)

Java代码格式化工具

Parameters:

formatConfigFile - EclipseCodeFormatter 格式化规则文件路径

formatConfigFileProfile - EclipseCodeFormatter 格式化规则文件中的 name 属性，具体使用哪个 profile

importsSorter - Java import代码格式化工具

JavaCodeFormatter

public JavaCodeFormatter(String formatConfigFile,
                         String formatConfigFileProfile,
                         ImportsSorter importsSorter)

Java代码格式化工具

Parameters:

formatConfigFile - EclipseCodeFormatter 格式化规则文件路径

formatConfigFileProfile - EclipseCodeFormatter 格式化规则文件中的 name 属性，具体使用哪个 profile

importsSorter - Java import代码格式化工具

JavaCodeFormatter

public JavaCodeFormatter(ImportsSorter importsSorter)

Java代码格式化工具，格式化规则使用

  eclipse-formatter-config/Default-Formatter-1.7.xml
  eclipse-formatter-config/Default-Formatter-1.8.xml
  eclipse-formatter-config/Default-Formatter-11.0.xml
  eclipse-formatter-config/Default.importorder
 

Parameters:

importsSorter - Java import代码格式化工具

Method Detail

formatText

public String formatText(StringBuilder fileContent)
                  throws org.eclipse.jface.text.BadLocationException

格式化 Java 代码

Parameters:

fileContent - 文件内容

Returns:

格式化之后的内容

Throws:

org.eclipse.jface.text.BadLocationException - 异常信息

formatFile

public boolean formatFile(String filePath)

格式化 Java 代码

Parameters:

filePath - 文件路径

Returns:

true: 格式化成功; false: 格式化失败

formatDirectory

public List<String> formatDirectory(String directoryPath)

格式化 Java 代码

Parameters:

directoryPath - 文件夹路径

Returns:

true: 格式化成功; false: 格式化失败