Format (plugin-maven 2.41.1 API)

java.lang.Object
- com.diffplug.spotless.maven.FormatterFactory
- - com.diffplug.spotless.maven.generic.Format

```
public class Format
extends FormatterFactory
```
A FormatterFactory implementation that corresponds to <format>...</format> configuration element.
It defines a formatter for custom includes/excludes that executes list of generic, language agnostic steps, like LicenseHeader.

Constructor Summary

Constructors
Constructor Description

Format()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addBiome(Biome biome)`	Adds a step to this format that format code with the Biome formatter.
`void`	`addRome(Rome rome)`	Deprecated. Rome has transitioned to Biome.
`java.util.Set<java.lang.String>`	`defaultIncludes(org.apache.maven.project.MavenProject project)`
`java.lang.String`	`licenseHeaderDelimiter()`

Methods inherited from class com.diffplug.spotless.maven.FormatterFactory
addEclipseWtp, addEndWithNewline, addIndent, addJsr223, addLicenseHeader, addNativeCmd, addPrettier, addReplace, addReplaceRegex, addStepFactory, addToggleOffOn, addTrimTrailingWhitespace, excludes, includes, newFormatter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Format
```
public Format()
```
- Method Detail
  - defaultIncludes
```
public java.util.Set<java.lang.String> defaultIncludes(org.apache.maven.project.MavenProject project)
```
    Specified by:
    
    defaultIncludes in class FormatterFactory
  - licenseHeaderDelimiter
```
public java.lang.String licenseHeaderDelimiter()
```
    Specified by:
    
    licenseHeaderDelimiter in class FormatterFactory
  - addBiome
```
public void addBiome(Biome biome)
```
    Adds a step to this format that format code with the Biome formatter.
    
    Parameters:
    
    biome - Biome configuration to use.
  - addRome
```
@Deprecated
public void addRome(Rome rome)
```
    Deprecated.
    Rome has transitioned to Biome. Use addBiome(Biome).
    
    Adds a step to this format that format code with the Rome formatter.
    
    Parameters:
    
    rome - Rome configuration to use.