com.diffplug.spotless.changelog

Class Changelog

java.lang.Object

com.diffplug.spotless.changelog.Changelog

public class Changelog
extends Object

Partitions a string into its changelog headers and the release notes under each header.

Capable of round-tripping - if you change the strings inside ParsedChangelog, you can write out a new changelog with new content, while preserving all formatting and non-changelog content in the string.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Changelog.VersionEntry Contains everything about a single entry in the changelog list.

Constructor Summary

Constructors

Constructor and Description
Changelog(String contentRaw) Takes a changelog string as its argument.

Method Summary

Modifier and Type	Method and Description
LinkedHashMap<Integer,String>	errors() Map from line number to the error message, in the order they were encountered.
boolean	noUnreleasedChanges() Returns true if there are no unreleased changes.
Changelog	releaseUnreleased(String version, String date) Returns a new changelog where the [Unreleased] section has been released with the given version and date.
String	toString() Returns the full content of this changelog as a string, with the same newlines as the input string.
String	toStringUnix() Returns the full content of this changelog as a string unix-newlines.
String	unreleasedChanges() Returns the string describing unreleased changes - starts with a newline, and has unix newlines.
@NullOr String	versionLast() Returns the most recently published version, if any.

Methods inherited from class java.lang.Object

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

Constructor Detail

Changelog

public Changelog(String contentRaw)

Takes a changelog string as its argument.

Method Detail

toStringUnix

public String toStringUnix()

Returns the full content of this changelog as a string unix-newlines.

toString

public String toString()

Returns the full content of this changelog as a string, with the same newlines as the input string.

Overrides:

toString in class Object

versionLast

public @NullOr String versionLast()

Returns the most recently published version, if any.

unreleasedChanges

public String unreleasedChanges()

Returns the string describing unreleased changes - starts with a newline, and has unix newlines.

noUnreleasedChanges

public boolean noUnreleasedChanges()

Returns true if there are no unreleased changes.

errors

public LinkedHashMap<Integer,String> errors()

Map from line number to the error message, in the order they were encountered.

releaseUnreleased

public Changelog releaseUnreleased(String version,
                                   String date)

Returns a new changelog where the [Unreleased] section has been released with the given version and date.