org.unbrokendome.gradle.plugins.gitversion.internal

Interface MatchResult

All Known Implementing Classes:

PatternMatchingMatchResult, SimpleMatchResult

public interface MatchResult

Method Summary

Modifier and Type	Method and Description
static MatchResult	fromBoolean(boolean match, java.lang.String description)
java.lang.String	getDescription() Gets a description as to why the match succeeded or failed; intended for logging purposes.
boolean	isMatch()
static MatchResult	match(java.lang.String description)
static MatchResult	mismatch(java.lang.String description)

Method Detail

isMatch

boolean isMatch()

getDescription

@Nonnull
java.lang.String getDescription()

Gets a description as to why the match succeeded or failed; intended for logging purposes.

Returns:

a description of the (mis)match

fromBoolean

@Nonnull
static MatchResult fromBoolean(boolean match,
                                        java.lang.String description)

match

@Nonnull
static MatchResult match(java.lang.String description)

mismatch

@Nonnull
static MatchResult mismatch(java.lang.String description)