Interface ChangelogRequest

All Known Implementing Classes:
DefaultChangelogRequest
public interface ChangelogRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable CallbackHandler
    getCallbackHandler()
    The callback handler to receive status information while the changelog file is created.
    @Nullable Set<String>
    getIncludedModules()
    If this set is not empty, only those modules included here are used to create the changelog.
    List<ChangelogType>
    getTypes()
    The changelog types for this request.
    @Nullable Nice2Version
    getVersion()
    Include only changelogs whose version is greater or equal to the returned one.
    boolean
    isApplyFinalizer()
    Whether to apply finalizing node processors to the generated changelog.

  • Method Details

    • getVersion

      @Nullable @Nullable Nice2Version getVersion()
      Include only changelogs whose version is greater or equal to the returned one. If null is returned, all changelogs are included.

    • getTypes

      List<ChangelogType> getTypes()
      The changelog types for this request.

    • getIncludedModules

      @Nullable @Nullable Set<String> getIncludedModules()
      If this set is not empty, only those modules included here are used to create the changelog.

    • getCallbackHandler

      @Nullable @Nullable CallbackHandler getCallbackHandler()
      The callback handler to receive status information while the changelog file is created.

    • isApplyFinalizer

      boolean isApplyFinalizer()
      Whether to apply finalizing node processors to the generated changelog.