org.ysb33r.gradle.gradletest

Interface DeprecationMessages

public interface DeprecationMessages

Configuring how deprecation messages should be handled.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
void	failOn(java.util.Collection<java.lang.String> msgPatterns) Add deprecation message patterns to the default message sets.
void	failOn(java.lang.String... msgPatterns) Add deprecation message patterns to the default message sets.
default java.util.Set<java.lang.String>	getDefaultMessageChecks() Returns the list of default deprecation messages.
org.gradle.api.provider.Provider<java.lang.Boolean>	getFailIfFound() Whether deprecation checking should fail the build if any deprecation messages are found.
org.gradle.api.provider.Provider<java.util.Set<java.lang.String>>	getFailureMessages() Messages on which the test will fail if setFailIfFound(Boolean) is set to true.
org.gradle.api.provider.Provider<java.util.Set<java.lang.String>>	getIgnoreMessages() Messages on which the test will be ignroed if setFailIfFound(Boolean) is set to true.
org.gradle.api.provider.Provider<java.lang.Boolean>	getInheritDefaultFailures() Whether to inherit the default set of deprecation messages can be inherited.
org.gradle.api.provider.Provider<java.lang.Boolean>	getInheritDefaultIgnores() Whether to inherit the default set of ignored deprecation messages can be inherited.
void	ignoreIf(java.util.Collection<java.lang.String> msgPatterns) Add deprecation message patterns to the default message sets.
void	ignoreIf(java.lang.String... msgPatterns) Add deprecation message patterns to the default message sets.
void	setFailIfFound(java.lang.Boolean flag) Turns deprecation checking on or off.
void	setFailOn(java.util.Collection<java.lang.String> msgPatterns) Replace the set of default deprevation messages.
void	setIgnoreIf(java.util.Collection<java.lang.String> msgPatterns) Replace the set of default deprevation messages.

Method Detail

getFailIfFound

org.gradle.api.provider.Provider<java.lang.Boolean> getFailIfFound()

Whether deprecation checking should fail the build if any deprecation messages are found.

Returns:

If setFailIfFound(Boolean) has been called. return that set value, otherwise true.

setFailIfFound

void setFailIfFound(java.lang.Boolean flag)

Turns deprecation checking on or off.

Overrides previous calls to setFailIfFound(Boolean).

Parameters:

flag - true turns on check.

getDefaultMessageChecks

default java.util.Set<java.lang.String> getDefaultMessageChecks()

Returns the list of default deprecation messages.

This list cannot be modified and messages added or removed.

Returns:

Message list

Since:

5.0 (In 4.0 this returned a List.

getFailureMessages

org.gradle.api.provider.Provider<java.util.Set<java.lang.String>> getFailureMessages()

Messages on which the test will fail if setFailIfFound(Boolean) is set to true.

Returns:

Set of strings. If setFailIfFound(Boolean) was set to true, an empty set is returned.

setFailOn

void setFailOn(java.util.Collection<java.lang.String> msgPatterns)

Replace the set of default deprevation messages.

Parameters:

msgPatterns - New set of patterns.

failOn

void failOn(java.lang.String... msgPatterns)

Add deprecation message patterns to the default message sets.

Parameters:

msgPatterns - Additional set of patterns

failOn

void failOn(java.util.Collection<java.lang.String> msgPatterns)

Add deprecation message patterns to the default message sets.

Parameters:

msgPatterns - Additional set of patterns

getIgnoreMessages

org.gradle.api.provider.Provider<java.util.Set<java.lang.String>> getIgnoreMessages()

Messages on which the test will be ignroed if setFailIfFound(Boolean) is set to true.

Returns:

Set of strings.

setIgnoreIf

void setIgnoreIf(java.util.Collection<java.lang.String> msgPatterns)

Replace the set of default deprevation messages.

Parameters:

msgPatterns - New set of patterns.

ignoreIf

void ignoreIf(java.lang.String... msgPatterns)

Add deprecation message patterns to the default message sets.

Parameters:

msgPatterns - Additional set of patterns

ignoreIf

void ignoreIf(java.util.Collection<java.lang.String> msgPatterns)

Add deprecation message patterns to the default message sets.

Parameters:

msgPatterns - Additional set of patterns

getInheritDefaultFailures

org.gradle.api.provider.Provider<java.lang.Boolean> getInheritDefaultFailures()

Whether to inherit the default set of deprecation messages can be inherited.

If setFailOn(Collection)} was called previously, this will be set to false.

Returns:

true if default messages can be inherited. Always contains a value.

getInheritDefaultIgnores

org.gradle.api.provider.Provider<java.lang.Boolean> getInheritDefaultIgnores()

Whether to inherit the default set of ignored deprecation messages can be inherited.

If setIgnoreIf(Collection)} was called previously, this will be set to false.

Returns:

true if default ignored messages can be inherited. Always contains a value.