com.github.ayltai.gradle.plugin

Class FmtOptions

java.lang.Object

com.github.ayltai.gradle.plugin.Options

com.github.ayltai.gradle.plugin.FmtOptions

All Implemented Interfaces:

java.io.Serializable

public class FmtOptions
extends Options

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	check
protected boolean	diff
protected boolean	list
protected boolean	recursive
protected boolean	write

Fields inherited from class com.github.ayltai.gradle.plugin.Options

name, noColor

Constructor Summary

Constructors

Constructor and Description
FmtOptions(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	check(boolean check) Checks if the input is formatted if true is specified.
void	diff(boolean diff) Displays diffs of formatting changes if true is specified.
void	list(boolean list) Lists the files containing formatting inconsistencies if true is specified.
void	recursive(boolean recursive) Processes files in subdirectories if true is specified.
void	write(boolean write) Overwrites the input files if true is specified.

Methods inherited from class com.github.ayltai.gradle.plugin.Options

noColor

Methods inherited from class java.lang.Object

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

Field Detail

list

protected boolean list

write

protected boolean write

diff

protected boolean diff

check

protected boolean check

recursive

protected boolean recursive

Constructor Detail

FmtOptions

public FmtOptions(@Nonnull
                  java.lang.String name)

Method Detail

list

public void list(boolean list)

Lists the files containing formatting inconsistencies if true is specified.

Default is false.

Parameters:

list - true to list the files containing formatting inconsistencies.

write

public void write(boolean write)

Overwrites the input files if true is specified.

Default is false.

Parameters:

write - true to overwrite the input files.

diff

public void diff(boolean diff)

Displays diffs of formatting changes if true is specified.

Default is false.

Parameters:

diff - true to display diffs of formatting changes.

check

public void check(boolean check)

Checks if the input is formatted if true is specified.

Exit status will be 0 if all input is properly formatted and non-zero otherwise.

Default is false.

Parameters:

check - true to check if the input is formatted.

recursive

public void recursive(boolean recursive)

Processes files in subdirectories if true is specified.

By default, only the given directory (or current directory) is processed.

Default is false.

Parameters:

recursive - true to process files in subdirectories.