Package org.springframework.boot.autoconfigure.condition

Class ConditionOutcome

java.lang.Object

org.springframework.boot.autoconfigure.condition.ConditionOutcome

public class ConditionOutcome
extends Object

Outcome for a condition match, including log message.

Since:

1.0.0

Author:

Phillip Webb

See Also:

• ConditionMessage

Constructor Summary

Constructors

Constructor	Description
ConditionOutcome(boolean match, String message)	Create a new ConditionOutcome instance.
ConditionOutcome(boolean match, ConditionMessage message)	Create a new ConditionOutcome instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ConditionMessage	getConditionMessage()	Return an outcome message or null.
String	getMessage()	Return an outcome message or null.
int	hashCode()
static ConditionOutcome	inverse(ConditionOutcome outcome)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.5.0 for removal in 3.7.0 in favor of ConditionOutcome(boolean, ConditionMessage)
boolean	isMatch()	Return true if the outcome was a match.
static ConditionOutcome	match()	Create a new ConditionOutcome instance for a 'match'.
static ConditionOutcome	match(String message)	Create a new ConditionOutcome instance for 'match'.
static ConditionOutcome	match(ConditionMessage message)	Create a new ConditionOutcome instance for 'match'.
static ConditionOutcome	noMatch(String message)	Create a new ConditionOutcome instance for 'no match'.
static ConditionOutcome	noMatch(ConditionMessage message)	Create a new ConditionOutcome instance for 'no match'.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConditionOutcome

public ConditionOutcome(boolean match,
 String message)

Create a new ConditionOutcome instance. For more consistent messages consider using ConditionOutcome(boolean, ConditionMessage).

Parameters:

match - if the condition is a match

message - the condition message

ConditionOutcome

public ConditionOutcome(boolean match,
 ConditionMessage message)

Create a new ConditionOutcome instance.

Parameters:

match - if the condition is a match

message - the condition message

Method Details

match

public static ConditionOutcome match()

Create a new ConditionOutcome instance for a 'match'.

Returns:

the ConditionOutcome

match

public static ConditionOutcome match(String message)

Create a new ConditionOutcome instance for 'match'. For more consistent messages consider using match(ConditionMessage).

Parameters:

message - the message

Returns:

the ConditionOutcome

match

public static ConditionOutcome match(ConditionMessage message)

Create a new ConditionOutcome instance for 'match'.

Parameters:

message - the message

Returns:

the ConditionOutcome

noMatch

public static ConditionOutcome noMatch(String message)

Create a new ConditionOutcome instance for 'no match'. For more consistent messages consider using noMatch(ConditionMessage).

Parameters:

message - the message

Returns:

the ConditionOutcome

noMatch

public static ConditionOutcome noMatch(ConditionMessage message)

Create a new ConditionOutcome instance for 'no match'.

Parameters:

message - the message

Returns:

the ConditionOutcome

isMatch

public boolean isMatch()

Return true if the outcome was a match.

Returns:

true if the outcome matches

getMessage

public String getMessage()

Return an outcome message or null.

Returns:

the message or null

getConditionMessage

public ConditionMessage getConditionMessage()

Return an outcome message or null.

Returns:

the message or null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

inverse

@Deprecated(since="3.5.0",
            forRemoval=true)
public static ConditionOutcome inverse(ConditionOutcome outcome)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.5.0 for removal in 3.7.0 in favor of ConditionOutcome(boolean, ConditionMessage)

Return the inverse of the specified condition outcome.

Parameters:

outcome - the outcome to inverse

Returns:

the inverse of the condition outcome

Since:

1.3.0