com.github.myoss.phoenix.code.format.eclipse

类 JavaCodeFormatter

java.lang.Object

com.github.myoss.phoenix.code.format.eclipse.JavaCodeFormatter

public class JavaCodeFormatter
extends Object

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

从以下版本开始:

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

作者:

Jerry.Chen

字段概要

字段

限定符和类型	字段和说明
protected org.eclipse.jdt.internal.formatter.DefaultCodeFormatter	defaultCodeFormatter
protected ImportsSorter	importsSorter
static String	JAVA_VERSION 当前项目使用的 Java 版本
static Pattern	TRAILING_SPACES 匹配行尾空格

构造器概要

构造器

构造器和说明
JavaCodeFormatter(ImportsSorter importsSorter) Java代码格式化工具，格式化规则使用 eclipse-formatter-config/Default-Formatter-1.7.xml eclipse-formatter-config/Default-Formatter-1.8.xml eclipse-formatter-config/Default.importorder
JavaCodeFormatter(Properties properties, ImportsSorter importsSorter) Java代码格式化工具
JavaCodeFormatter(String formatConfigFile, String formatConfigFileProfile, ImportsSorter importsSorter) Java代码格式化工具
JavaCodeFormatter(URL formatConfigFile, String formatConfigFileProfile, ImportsSorter importsSorter) Java代码格式化工具

方法概要

限定符和类型	方法和说明
List<String>	formatDirectory(String directoryPath) 格式化 Java 代码
boolean	formatFile(String filePath) 格式化 Java 代码
String	formatText(StringBuilder fileContent) 格式化 Java 代码

从类继承的方法 java.lang.Object

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

字段详细资料

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

构造器详细资料

JavaCodeFormatter

public JavaCodeFormatter(Properties properties,
                         ImportsSorter importsSorter)

Java代码格式化工具

参数:

properties - EclipseCodeFormatter 格式化规则

importsSorter - Java import代码格式化工具

JavaCodeFormatter

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

Java代码格式化工具

参数:

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

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

importsSorter - Java import代码格式化工具

JavaCodeFormatter

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

Java代码格式化工具

参数:

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.importorder
 

参数:

importsSorter - Java import代码格式化工具

方法详细资料

formatText

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

格式化 Java 代码

参数:

fileContent - 文件内容

返回:

格式化之后的内容

抛出:

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

formatFile

public boolean formatFile(String filePath)

格式化 Java 代码

参数:

filePath - 文件路径

返回:

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

formatDirectory

public List<String> formatDirectory(String directoryPath)

格式化 Java 代码

参数:

directoryPath - 文件夹路径

返回:

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