Index (toolarium-changelog-parser 0.0.1 API)

A B C D E F G H I L M N P Q R S T U V W Y
All Classes All Packages

A

add(String) - Method in class com.github.toolarium.changelog.dto.ChangelogSection: Add a comment
ADDED - com.github.toolarium.changelog.dto.ChangelogChangeType: ADDED
addError(List<String>, String, String) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Adds an error
addError(List<String>, String, String) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Adds an error
addList(List<String>, List<String>) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Add list
addList(List<String>, List<String>) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Add list
addSection(ChangelogSection) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Add a section
append(StringBuilder, String) - Method in class com.github.toolarium.changelog.formatter.ChangelogFormatter: Append a string

B

build() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Build
BUILD_TIMESTAMP - Static variable in class com.github.toolarium.changelog.Version: The build timestamp
Builder() - Constructor for class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Constructor for Builder

C

CHANGED - com.github.toolarium.changelog.dto.ChangelogChangeType: CHANGED
Changelog - Class in com.github.toolarium.changelog.dto: The change-log
Changelog(String, String) - Constructor for class com.github.toolarium.changelog.dto.Changelog: Create a new change-log
Changelog(String, String, List<ChangelogEntry>) - Constructor for class com.github.toolarium.changelog.dto.Changelog: Create a new change-log
ChangelogChangeType - Enum in com.github.toolarium.changelog.dto: Defines the change-log change types.
ChangelogConfig - Class in com.github.toolarium.changelog.config: Defines the change-log parse and format configuration
ChangelogConfig() - Constructor for class com.github.toolarium.changelog.config.ChangelogConfig: Constructor for ChangelogConfig
ChangelogConfig(char, char, boolean, boolean, boolean) - Constructor for class com.github.toolarium.changelog.config.ChangelogConfig: Constructor for ChangelogConfig
ChangelogContentParser - Class in com.github.toolarium.changelog.parser.impl
ChangelogContentParser() - Constructor for class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Constructor for ChangelogParser
ChangelogEntry - Class in com.github.toolarium.changelog.dto: The change-log entry
ChangelogEntry() - Constructor for class com.github.toolarium.changelog.dto.ChangelogEntry: Constructor for ChangelogEntry
ChangelogEntry(Version, LocalDate) - Constructor for class com.github.toolarium.changelog.dto.ChangelogEntry: Constructor for ChangelogEntry
ChangelogEntry(Version, LocalDate, String, String) - Constructor for class com.github.toolarium.changelog.dto.ChangelogEntry: Constructor for ChangelogEntry
ChangelogEntry(Version, LocalDate, String, String, boolean, boolean, List<ChangelogSection>) - Constructor for class com.github.toolarium.changelog.dto.ChangelogEntry: Constructor for ChangelogEntry
ChangelogEntry.Builder - Class in com.github.toolarium.changelog.dto: The builder
ChangelogFactory - Class in com.github.toolarium.changelog: The change-log factory
ChangelogFormatter - Class in com.github.toolarium.changelog.formatter: Implements a change-log formatter
ChangelogFormatter() - Constructor for class com.github.toolarium.changelog.formatter.ChangelogFormatter: Constructor for ChangelogParser
ChangelogFormatter(ChangelogConfig) - Constructor for class com.github.toolarium.changelog.formatter.ChangelogFormatter: Constructor for ChangelogParser
ChangelogMain - Class in com.github.toolarium.changelog: Implement the change-log main applciation
ChangelogMain() - Constructor for class com.github.toolarium.changelog.ChangelogMain: Constructor for ChangelogMain
ChangelogParser - Class in com.github.toolarium.changelog.parser: Implements a change-log parser following https://keepachangelog.com.
ChangelogParser() - Constructor for class com.github.toolarium.changelog.parser.ChangelogParser: Constructor for ChangelogParser
ChangelogParseResult - Class in com.github.toolarium.changelog.parser: The changelog parse result.
ChangelogParseResult() - Constructor for class com.github.toolarium.changelog.parser.ChangelogParseResult
ChangelogSection - Class in com.github.toolarium.changelog.dto: Defines the change-log section
ChangelogSection(ChangelogChangeType) - Constructor for class com.github.toolarium.changelog.dto.ChangelogSection: Constructor for ChangelogSection
ChangelogSection(ChangelogChangeType, List<String>) - Constructor for class com.github.toolarium.changelog.dto.ChangelogSection: Constructor for ChangelogSection
ChangelogValidator - Class in com.github.toolarium.changelog.validator: Change-log validator
ChangelogValidator() - Constructor for class com.github.toolarium.changelog.validator.ChangelogValidator: Constructor for ChangelogValidator
ChangelogValidator(ChangelogConfig) - Constructor for class com.github.toolarium.changelog.validator.ChangelogValidator: Constructor for ChangelogValidator
com.github.toolarium.changelog - package com.github.toolarium.changelog
com.github.toolarium.changelog.config - package com.github.toolarium.changelog.config
com.github.toolarium.changelog.dto - package com.github.toolarium.changelog.dto
com.github.toolarium.changelog.exception - package com.github.toolarium.changelog.exception
com.github.toolarium.changelog.formatter - package com.github.toolarium.changelog.formatter
com.github.toolarium.changelog.parser - package com.github.toolarium.changelog.parser
com.github.toolarium.changelog.parser.impl - package com.github.toolarium.changelog.parser.impl
com.github.toolarium.changelog.validator - package com.github.toolarium.changelog.validator
compareTo(ChangelogEntry) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry
COMPONENT_ID - Static variable in class com.github.toolarium.changelog.Version: The component id
convertVersion(List<String>, String) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Convert input version
createSortedChangelogEntryReferenceList(List<ChangelogEntry>) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Create a change-log entry reference list

D

date(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Set the release date
DEPRECATED - com.github.toolarium.changelog.dto.ChangelogChangeType: DEPRECATED
description(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Set the release description
DESCRIPTION - Static variable in class com.github.toolarium.changelog.Version: The description

E

equals(Object) - Method in class com.github.toolarium.changelog.config.ChangelogConfig
equals(Object) - Method in class com.github.toolarium.changelog.dto.Changelog
equals(Object) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry
equals(Object) - Method in class com.github.toolarium.changelog.dto.ChangelogSection
equals(Object) - Method in class com.github.toolarium.changelog.parser.ChangelogParseResult
executeCalls(List<ParameterExecutionHolder>, ParameterParser) - Method in class com.github.toolarium.changelog.ChangelogMain

F

FIXED - com.github.toolarium.changelog.dto.ChangelogChangeType: FIXED
format(ChangelogConfig, Changelog) - Method in class com.github.toolarium.changelog.ChangelogFactory: Format a change-log
format(ChangelogConfig, Path) - Method in class com.github.toolarium.changelog.ChangelogFactory: Format a change-log
format(Changelog) - Method in class com.github.toolarium.changelog.formatter.ChangelogFormatter: Format

G

getAdditionalVersionText() - Method in class com.github.toolarium.changelog.ChangelogMain
getChangeCommentList() - Method in class com.github.toolarium.changelog.dto.ChangelogSection: Get the change comment list
getChangelog() - Method in class com.github.toolarium.changelog.parser.ChangelogParseResult: Get the change-log
getChangelogConfig() - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Get the change-log configuration
getChangeType() - Method in class com.github.toolarium.changelog.dto.ChangelogSection: Get the change type
getDescription() - Method in class com.github.toolarium.changelog.dto.Changelog: The description.
getDescription() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Get the release description.
getEntries() - Method in class com.github.toolarium.changelog.dto.Changelog: The change-log entries.
getEntry(String) - Method in class com.github.toolarium.changelog.dto.Changelog: Search a version entry.
getErrorMessageList() - Method in class com.github.toolarium.changelog.parser.ChangelogParseResult: Get the error message list
getHeaderSeparator() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Get the header character
getIdCommentCheckExpression() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Get the id comment check expression
getInfo() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Get the release information.
getInstance() - Static method in class com.github.toolarium.changelog.ChangelogFactory: Get the instance
getItemSeparator() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Get the item character
getLinkCommentCheckExpression() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Get the link comment check expression
getLogger() - Method in class com.github.toolarium.changelog.ChangelogMain
getProjectName() - Method in class com.github.toolarium.changelog.dto.Changelog: Get the project name.
getReleaseDate() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Get the release date
getReleaseVersion() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Get the release version
getSectionCharacter() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Get the section character
getSectionList() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Get the section list.
getTypeName() - Method in enum com.github.toolarium.changelog.dto.ChangelogChangeType: Get the type name
getValidationErrorList() - Method in exception com.github.toolarium.changelog.exception.ValidationException: Get the validation error list
getVersion() - Static method in class com.github.toolarium.changelog.Version: Get the version number
getVersionNumber() - Method in class com.github.toolarium.changelog.ChangelogMain
GROUP_ID - Static variable in class com.github.toolarium.changelog.Version: The group id

H

hasBracketsAroundVersion() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Get has brackets around version
hashCode() - Method in class com.github.toolarium.changelog.config.ChangelogConfig
hashCode() - Method in class com.github.toolarium.changelog.dto.Changelog
hashCode() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry
hashCode() - Method in class com.github.toolarium.changelog.dto.ChangelogSection
hashCode() - Method in class com.github.toolarium.changelog.parser.ChangelogParseResult
hasIdInComment(String) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Check if the text has an id
hasLinkInComment(String) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Check if the text has a link

I

IDENTIFIER_IN_CONTENT - Static variable in class com.github.toolarium.changelog.config.ChangelogConfig: Regular expression: identifier in a content pattern
info(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Set the release info
init(String) - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser
init(ByteArray) - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser
initParameters() - Method in class com.github.toolarium.changelog.ChangelogMain
IS_RELEASE_VERSION - Static variable in class com.github.toolarium.changelog.Version: Define if it is a release version
isIdInCommentEnabled() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Check if ID's in comment are supported
isLinkInCommentEnabled() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Check if links in comment are supported
isReleased() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Describes if it is relased or is unreleased.
isSupportBracketsAroundVersion() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Check if brackets around version is supported
isSupportReleaseInfo() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Check if release information in header is supported
isSupportUnreleased() - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Check if unreleased is supported

L

LICENSE - Static variable in class com.github.toolarium.changelog.Version: The license
LICENSE_ORGANISATION - Static variable in class com.github.toolarium.changelog.Version: The license organisation
LINK_IN_CONTENT - Static variable in class com.github.toolarium.changelog.config.ChangelogConfig: Regular expression: link in a content pattern

M

main(String[]) - Static method in class com.github.toolarium.changelog.ChangelogMain: The main entry-point of an application.
main(String[]) - Static method in class com.github.toolarium.changelog.Version: Main class to print build / version information
MAJOR_NUMBER - Static variable in class com.github.toolarium.changelog.Version: The major number
MINOR_NUMBER - Static variable in class com.github.toolarium.changelog.Version: The minor number

N

newline(StringBuilder) - Method in class com.github.toolarium.changelog.formatter.ChangelogFormatter: Adds a newline
NEWLINE - Static variable in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: The newline

P

PACKAGE - Static variable in class com.github.toolarium.changelog.Version: The package
parse(String) - Method in class com.github.toolarium.changelog.ChangelogFactory: Parse a change-log
parse(String) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Parse a change-log content
parse(Path) - Method in class com.github.toolarium.changelog.ChangelogFactory: Parse a change-log
parse(Path) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Parse a change-log
parseContent(ByteArray) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Parse a change-log content
prepareBracketExpression(ChangelogConfig, String) - Method in class com.github.toolarium.changelog.formatter.ChangelogFormatter: Prepare bracket expression
PROJECT_NAME - Static variable in class com.github.toolarium.changelog.Version: The project name
PROJECT_TYPE - Static variable in class com.github.toolarium.changelog.Version: The project type

Q

QUALIFIER - Static variable in class com.github.toolarium.changelog.Version: The version qualifier

R

readBracketExpression(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Read bracket expression
readChangelogEntryList(ChangelogContentParser, Changelog) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Read the change-log entry list
readChangelogHeader(ChangelogContentParser, ChangelogParseResult) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Read the change-log entry list
readChangelogSectionItemList(ChangelogContentParser, ChangelogEntry, ChangelogSection) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Read the change-log section list
readChangelogSectionList(ChangelogContentParser, ChangelogEntry) - Method in class com.github.toolarium.changelog.parser.ChangelogParser: Read the change-log section list
readChangelogSeparator() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read the changelog separator
readChangelogText() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read the description
readDate() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read the date
readDescription() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read the description
readEOL() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read until end of line.
readHeaderEnd() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read the header end
readHeaderSeparator() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read the header separator.
readItems() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read section items
readVersion() - Method in class com.github.toolarium.changelog.parser.impl.ChangelogContentParser: Read the version
REMOVED - com.github.toolarium.changelog.dto.ChangelogChangeType: REMOVED
REVISION_NUMBER - Static variable in class com.github.toolarium.changelog.Version: The revision number

S

SCM_NUMBER - Static variable in class com.github.toolarium.changelog.Version: The source management number
SECURITY - com.github.toolarium.changelog.dto.ChangelogChangeType: SECURITY
setChangelog(Changelog) - Method in class com.github.toolarium.changelog.parser.ChangelogParseResult: Set the change-log
setChangelogFilename(String) - Method in class com.github.toolarium.changelog.ChangelogMain: Sets the change-log file
setDescription(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Set the release description.
setErrorMessageList(List<String>) - Method in class com.github.toolarium.changelog.parser.ChangelogParseResult: Set the error message list
setHasBracketsAroundVersion(boolean) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Set has brackets around version
setHeaderSeparator(char) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Set the header separator
setIdCommentCheckExpression(String) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Set the id comment check expression
setInfo(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Set the release information.
setItemSeparator(char) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Set the item separator
setLinkCommentCheckExpression(String) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Set the link comment check expression
setReleased() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Set released
setReleaseDate(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Set the release date
setReleaseVersion(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Get the release version
setSectionCharacter(char) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Set the section separator
setSupportBracketsAroundVersion(boolean) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Set if brackets around version is supported
setSupportReleaseInfo(boolean) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Set if release information in header is supported
setSupportUnreleased(boolean) - Method in class com.github.toolarium.changelog.config.ChangelogConfig: Set if unreleased is supported
setUnreleased() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Set unreleased
setWasYanked() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Set it it was considered as yanked.

T

toString() - Method in class com.github.toolarium.changelog.config.ChangelogConfig
toString() - Method in class com.github.toolarium.changelog.dto.Changelog
toString() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry
toString() - Method in class com.github.toolarium.changelog.dto.ChangelogSection
toString() - Method in exception com.github.toolarium.changelog.exception.ValidationException
toString() - Method in class com.github.toolarium.changelog.parser.ChangelogParseResult

U

URL - Static variable in class com.github.toolarium.changelog.Version: The url of the project

V

validate(ChangelogConfig, Changelog) - Method in class com.github.toolarium.changelog.ChangelogFactory: Validate a change-log
validate(ChangelogConfig, Changelog, String, String, String) - Method in class com.github.toolarium.changelog.ChangelogFactory: Validate a change-log
validate(ChangelogConfig, Path) - Method in class com.github.toolarium.changelog.ChangelogFactory: Validate a change-log
validate(ChangelogConfig, Path, String, String, String) - Method in class com.github.toolarium.changelog.ChangelogFactory: Validate a change-log
validate(Changelog) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate
validate(Changelog, String, String, String) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate
validate(Path) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate
validate(Path, String, String, String) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate
validateChangelogSections(Version, List<ChangelogSection>) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate entry order
validateEntries(List<ChangelogEntry>, Version) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate the header
validateEntry(ChangelogEntry) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate entry order
validateEntryOrder(List<ChangelogEntry>, Version) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate entry order
validateHeader(Changelog, String, String) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate the header
validateText(String, String) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate the text
validateUnreleasdEntry(Changelog) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate the unreleased entry
validateVersionExist(List<ChangelogEntry>, Version) - Method in class com.github.toolarium.changelog.validator.ChangelogValidator: Validate entry order
ValidationException - Exception in com.github.toolarium.changelog.exception: Defines the validation exception
ValidationException(String, List<String>) - Constructor for exception com.github.toolarium.changelog.exception.ValidationException: Constructor for ValidationException
valueOf(String) - Static method in enum com.github.toolarium.changelog.dto.ChangelogChangeType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.toolarium.changelog.dto.ChangelogChangeType: Returns an array containing the constants of this enum type, in the order they are declared.
version(String) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Set the release version
Version - Class in com.github.toolarium.changelog: The version class
Version() - Constructor for class com.github.toolarium.changelog.Version
VERSION - Static variable in class com.github.toolarium.changelog.Version: The full version number

W

wasYanked() - Method in class com.github.toolarium.changelog.dto.ChangelogEntry: Describes if it is considered yanked.

Y

yanked(boolean) - Method in class com.github.toolarium.changelog.dto.ChangelogEntry.Builder: Set yanked

A B C D E F G H I L M N P Q R S T U V W Y
All Classes All Packages