Package io.spring.javaformat.formatter

Class FileFormatter

java.lang.Object

io.spring.javaformat.formatter.FileFormatter

public class FileFormatter
extends Object

A code formatter designed to work with Files.

Author:

Phillip Webb

See Also:

Formatter

Constructor Summary

Constructors

Constructor	Description
FileFormatter()
FileFormatter(JavaFormatConfig javaFormatConfig)
FileFormatter(Formatter formatter)

Method Summary

Modifier and Type	Method	Description
FileEdit	formatFile(File file, Charset encoding)	Format the the given source file and return a FileEdit instance.
FileEdit	formatFile(File file, Charset encoding, String lineSeparator)	Format the the given source file and return a FileEdit instance.
Stream<FileEdit>	formatFiles(Iterable<File> files, Charset encoding)	Format the given source files and provide a Stream of FileEdit instances.
Stream<FileEdit>	formatFiles(Iterable<File> files, Charset encoding, String lineSeparator)	Format the given source files and provide a Stream of FileEdit instances.
Stream<FileEdit>	formatFiles(Stream<File> files, Charset encoding)	Format the given source files and provide a Stream of FileEdit instances.
Stream<FileEdit>	formatFiles(Stream<File> files, Charset encoding, String lineSeparator)	Format the given source files and provide a Stream of FileEdit instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileFormatter

public FileFormatter()

FileFormatter

public FileFormatter(JavaFormatConfig javaFormatConfig)

FileFormatter

public FileFormatter(Formatter formatter)

Method Detail

formatFiles

public Stream<FileEdit> formatFiles(Iterable<File> files,
                                    Charset encoding)

Format the given source files and provide a Stream of FileEdit instances.

Parameters:

files - the files to format

encoding - the source encoding

Returns:

a stream of formatted files that have edits

formatFiles

public Stream<FileEdit> formatFiles(Iterable<File> files,
                                    Charset encoding,
                                    String lineSeparator)

Format the given source files and provide a Stream of FileEdit instances.

Parameters:

files - the files to format

encoding - the source encoding

lineSeparator - the line separator

Returns:

a stream of formatted files that have edits

formatFiles

public Stream<FileEdit> formatFiles(Stream<File> files,
                                    Charset encoding)

Format the given source files and provide a Stream of FileEdit instances.

Parameters:

files - the files to format

encoding - the source encoding

Returns:

a stream of formatted files that have edits

formatFiles

public Stream<FileEdit> formatFiles(Stream<File> files,
                                    Charset encoding,
                                    String lineSeparator)

Format the given source files and provide a Stream of FileEdit instances.

Parameters:

files - the files to format

encoding - the source encoding

lineSeparator - the line separator

Returns:

a stream of formatted files that have edits

formatFile

public FileEdit formatFile(File file,
                           Charset encoding)

Format the the given source file and return a FileEdit instance.

Parameters:

file - the file to format

encoding - the source encoding

Returns:

a formatted file

formatFile

public FileEdit formatFile(File file,
                           Charset encoding,
                           String lineSeparator)

Format the the given source file and return a FileEdit instance.

Parameters:

file - the file to format

encoding - the source encoding

lineSeparator - the line separator

Returns:

a formatted file