org.springframework.boot.autoconfigure.condition

Class ConditionMessage

java.lang.Object

org.springframework.boot.autoconfigure.condition.ConditionMessage

public final class ConditionMessage
extends Object

A message associated with a ConditionOutcome. Provides a fluent builder style API to encourage consistency across all condition messages.

Since:

1.4.1

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ConditionMessage.Builder Builder used to create a ConditionMessage for a condition.
class	ConditionMessage.ItemsBuilder Builder used to create a ConditionMessage.ItemsBuilder for a condition.
static class	ConditionMessage.Style Render styles.

Method Summary

Modifier and Type	Method and Description
ConditionMessage.Builder	andCondition(Class<? extends Annotation> condition, Object... details) Return a new builder to construct a new ConditionMessage based on the instance and a new condition outcome.
ConditionMessage.Builder	andCondition(String condition, Object... details) Return a new builder to construct a new ConditionMessage based on the instance and a new condition outcome.
ConditionMessage	append(String message) Return a new ConditionMessage based on the instance and an appended message.
static ConditionMessage	empty() Factory method to return a new empty ConditionMessage.
boolean	equals(Object obj)
static ConditionMessage.Builder	forCondition(Class<? extends Annotation> condition, Object... details) Factory method for a builder to construct a new ConditionMessage for a condition.
static ConditionMessage.Builder	forCondition(String condition, Object... details) Factory method for a builder to construct a new ConditionMessage for a condition.
int	hashCode()
boolean	isEmpty() Return true if the message is empty.
static ConditionMessage	of(Collection<? extends ConditionMessage> messages) Factory method to create a new ConditionMessage comprised of the specified messages.
static ConditionMessage	of(String message, Object... args) Factory method to create a new ConditionMessage with a specific message.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

isEmpty

public boolean isEmpty()

Return true if the message is empty.

Returns:

if the message is empty

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

append

public ConditionMessage append(String message)

Return a new ConditionMessage based on the instance and an appended message.

Parameters:

message - the message to append

Returns:

a new ConditionMessage instance

andCondition

public ConditionMessage.Builder andCondition(Class<? extends Annotation> condition,
                                             Object... details)

Return a new builder to construct a new ConditionMessage based on the instance and a new condition outcome.

Parameters:

condition - the condition

details - details of the condition

Returns:

a ConditionMessage.Builder builder

See Also:

andCondition(String, Object...), forCondition(Class, Object...)

andCondition

public ConditionMessage.Builder andCondition(String condition,
                                             Object... details)

Return a new builder to construct a new ConditionMessage based on the instance and a new condition outcome.

Parameters:

condition - the condition

details - details of the condition

Returns:

a ConditionMessage.Builder builder

See Also:

andCondition(Class, Object...), forCondition(String, Object...)

empty

public static ConditionMessage empty()

Factory method to return a new empty ConditionMessage.

Returns:

a new empty ConditionMessage

of

public static ConditionMessage of(String message,
                                  Object... args)

Factory method to create a new ConditionMessage with a specific message.

Parameters:

message - the source message (may be a format string if args are specified)

args - format arguments for the message

Returns:

a new ConditionMessage instance

of

public static ConditionMessage of(Collection<? extends ConditionMessage> messages)

Factory method to create a new ConditionMessage comprised of the specified messages.

Parameters:

messages - the source messages (may be null)

Returns:

a new ConditionMessage instance

forCondition

public static ConditionMessage.Builder forCondition(Class<? extends Annotation> condition,
                                                    Object... details)

Factory method for a builder to construct a new ConditionMessage for a condition.

Parameters:

condition - the condition

details - details of the condition

Returns:

a ConditionMessage.Builder builder

See Also:

forCondition(String, Object...), andCondition(String, Object...)

forCondition

public static ConditionMessage.Builder forCondition(String condition,
                                                    Object... details)

Factory method for a builder to construct a new ConditionMessage for a condition.

Parameters:

condition - the condition

details - details of the condition

Returns:

a ConditionMessage.Builder builder

See Also:

forCondition(Class, Object...), andCondition(String, Object...)