oracle.javatools.formatter.java

Class JavaFormatter

java.lang.Object

oracle.javatools.formatter.java.JavaFormatter

public class JavaFormatter
extends java.lang.Object

Simple Java formatter that can format files and directories outside any workspace and project context and outside ADE.

Since:

12.1.2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	checkEncoding(java.lang.String encoding) Check the argument of the -encoding option, which should be a valid and supported encoding string.
static JdkVersion	checkSourceOption(java.lang.String source) Check the argument of the -source option, which should be something like '1.5', and should be a JDK version that the formatter supports.
static boolean	formatFile(java.io.File file, JdkVersion jdkVersion, SourcePreferences sourcePreferences, java.lang.String encoding, boolean quiet, int indent) Format one file.
static void	main(java.lang.String[] args) Entry point of the stand-alone JavaFormatter.

Methods inherited from class java.lang.Object

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

Method Detail

formatFile

public static boolean formatFile(java.io.File file,
                 JdkVersion jdkVersion,
                 SourcePreferences sourcePreferences,
                 java.lang.String encoding,
                 boolean quiet,
                 int indent)

Format one file.

Parameters:

file - The file

jdkVersion - The JdkVersion to use, if null the default JdkVersion is used

sourcePreferences - The preferences for formatting

encoding - The encoding, if null the default encoding is used

Returns:

True if the format succeeded, false otherwise

checkSourceOption

public static JdkVersion checkSourceOption(java.lang.String source)

Check the argument of the -source option, which should be something like '1.5', and should be a JDK version that the formatter supports.

Parameters:

source - The -source argument

Returns:

A valid JdkVersion if the argument is valid, null otherwise

checkEncoding

public static java.lang.String checkEncoding(java.lang.String encoding)

Check the argument of the -encoding option, which should be a valid and supported encoding string.

Parameters:

encoding - The -encoding argument such as UTF-8

Returns:

The same encoding string if it's valid, otherwise null

main

public static void main(java.lang.String[] args)

Entry point of the stand-alone JavaFormatter. Execute with no arguments to see the 'help' screen.

Parameters:

args - The arguments for the formatter