Package com.io7m.changelog.core

Interface CChangeType

All Known Implementing Classes:

CChange

@Immutable
public interface CChangeType

A change within a specific release.

Method Summary

Modifier and Type	Method	Description
default boolean	backwardsCompatible()
java.time.ZonedDateTime	date()
java.util.Optional<java.lang.String>	module()
java.lang.String	summary()
io.vavr.collection.List<java.lang.String>	tickets()

Method Detail

date

@Parameter
java.time.ZonedDateTime date()

Returns:

The change date

summary

@Parameter
java.lang.String summary()

Returns:

The change summary

tickets

@Parameter
io.vavr.collection.List<java.lang.String> tickets()

Returns:

The change tickets

module

@Parameter
java.util.Optional<java.lang.String> module()

Returns:

The module that this change affects

backwardsCompatible

@Default
@Parameter
default boolean backwardsCompatible()

Returns:

true iff the change is backwards compatible