Package com.io7m.changelog.core

Interface CChangelogType

All Known Implementing Classes:
CChangelog
@Immutable
public interface CChangelogType
The type of changelogs.

  • Method Details

    • project

      CProjectName project()
      Returns:
      The project name

    • releases

      java.util.Map<CVersion,​CRelease> releases()
      Returns:
      The list of releases

    • ticketSystems

      java.util.Map<java.lang.String,​CTicketSystem> ticketSystems()
      Returns:
      The ticket systems

    • releaseVersions

      default java.util.List<CVersion> releaseVersions()
      Returns:
      The list of available versions in ascending order

    • latestRelease

      default java.util.Optional<CRelease> latestRelease()
      Returns:
      The latest release, if one is defined

    • suggestNextRelease

      default CVersion suggestNextRelease() throws java.lang.IllegalArgumentException
      Suggest a new version number for the next release.
      Returns:
      A new version greater than any existing version
      Throws:
      java.lang.IllegalArgumentException - If a version cannot be determined

    • findTargetReleaseOrLatestOpen

      default java.util.Optional<CRelease> findTargetReleaseOrLatestOpen​(java.util.Optional<CVersion> version)
      Find the target release if one is specified, or return the current release otherwise, but only if either of those releases are open.
      Parameters:
      version - The release version
      Returns:
      The target release

    • findTargetReleaseOrLatest

      default java.util.Optional<CRelease> findTargetReleaseOrLatest​(java.util.Optional<CVersion> version)
      Find the target release if one is specified, or return the current release otherwise.
      Parameters:
      version - The release version
      Returns:
      The target release

    • findTargetRelease

      default java.util.Optional<CRelease> findTargetRelease​(CVersion version)
      Find the target release.
      Parameters:
      version - The release version
      Returns:
      The target release

    • findTicketSystem

      default java.util.Optional<java.lang.String> findTicketSystem​(java.util.Optional<java.lang.String> idOpt)
      Find the current ticket system.
      Parameters:
      idOpt - The ticket system ID, if any
      Returns:
      The ticket system if it exists

    • checkPreconditions

      @Check default void checkPreconditions()
      Check preconditions for the type.