Package com.diffplug.spotless

Interface FormatterFunc

All Known Subinterfaces:

FormatterFunc.Closeable, FormatterFunc.NeedsFile

All Known Implementing Classes:

RdfFormatterFunc

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface FormatterFunc

A Function<String, String> which can throw an exception. Technically, there is also a File argument which gets passed around as well, but that is invisible to formatters. If you need the File, see FormatterFunc.NeedsFile.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FormatterFunc.Closeable	Function<String, String> and BiFunction<String, File, String> whose implementation requires a resource which should be released when the function is no longer needed.
static interface	FormatterFunc.NeedsFile

Method Summary

Modifier and Type	Method	Description
String	apply(String input)
default String	apply(String unix, File file)
default List<Lint>	lint(String content, File file)	Calculates a list of lints against the given content.
static FormatterFunc	needsFile(FormatterFunc.NeedsFile needsFile)	Ideally, formatters don't need the underlying file.

Method Details

apply

String apply(String input)
      throws Exception

Throws:

Exception

apply

default String apply(String unix,
 File file)
              throws Exception

Throws:

Exception

lint

default List<Lint> lint(String content,
 File file)
                 throws Exception

Calculates a list of lints against the given content. By default, that's just an throwables thrown by the lint.

Throws:

Exception

needsFile

static FormatterFunc needsFile(FormatterFunc.NeedsFile needsFile)

Ideally, formatters don't need the underlying file. But in case they do, they should only use it's path, and should never read the content inside the file, because that breaks the Function<String, String> composition that Spotless is based on. For the rare case that you need access to the file, use this method or FormatterFunc.NeedsFile to create a FormatterFunc which needs the File.