ReadmeBuilder (builder 5.4.1 API)

java.lang.Object
- net.kemitix.checkstyle.ruleset.builder.ReadmeBuilder

@Component
public class ReadmeBuilder
extends Object

Field Summary

Fields
Modifier and Type Field Description

static String CHECKSTYLE

static String SEVNTU

Constructor Summary

Constructors
Constructor Description

ReadmeBuilder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`build(String readmeTemplate)`	Creates a readme based on the template, inserting lists of the enabled and disabled checkstyle and sevntu rules.

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

- Field Detail
  - CHECKSTYLE
```
public static final String CHECKSTYLE
```
    See Also:
    
    Constant Field Values
  - SEVNTU
```
public static final String SEVNTU
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReadmeBuilder
```
public ReadmeBuilder()
```
- Method Detail
  - build
```
public String build(String readmeTemplate)
```
    Creates a readme based on the template, inserting lists of the enabled and disabled checkstyle and sevntu rules.
    
    Parameters:
    
    readmeTemplate - the String.format compatible template
    
    Returns:
    
    the formatted readme document.