Class ConditionMessage
java.lang.Object
org.springframework.boot.autoconfigure.condition.ConditionMessage
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
Modifier and TypeClassDescriptionfinal class
Builder used to create aConditionMessage
for a condition.final class
Builder used to create anConditionMessage.ItemsBuilder
for a condition.static enum
Render styles. -
Method Summary
Modifier and TypeMethodDescriptionandCondition
(Class<? extends Annotation> condition, Object... details) Return a new builder to construct a newConditionMessage
based on the instance and a new condition outcome.andCondition
(String condition, Object... details) Return a new builder to construct a newConditionMessage
based on the instance and a new condition outcome.Return a newConditionMessage
based on the instance and an appended message.static ConditionMessage
empty()
Factory method to return a new emptyConditionMessage
.boolean
static ConditionMessage.Builder
forCondition
(Class<? extends Annotation> condition, Object... details) Factory method for a builder to construct a newConditionMessage
for a condition.static ConditionMessage.Builder
forCondition
(String condition, Object... details) Factory method for a builder to construct a newConditionMessage
for a condition.int
hashCode()
boolean
isEmpty()
Returntrue
if the message is empty.static ConditionMessage
Factory method to create a newConditionMessage
with a specific message.static ConditionMessage
of
(Collection<? extends ConditionMessage> messages) Factory method to create a newConditionMessage
comprised of the specified messages.toString()
-
Method Details
-
isEmpty
public boolean isEmpty()Returntrue
if the message is empty.- Returns:
- if the message is empty
-
equals
-
hashCode
public int hashCode() -
toString
-
append
Return a newConditionMessage
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 newConditionMessage
based on the instance and a new condition outcome.- Parameters:
condition
- the conditiondetails
- details of the condition- Returns:
- a
ConditionMessage.Builder
builder - See Also:
-
andCondition
Return a new builder to construct a newConditionMessage
based on the instance and a new condition outcome.- Parameters:
condition
- the conditiondetails
- details of the condition- Returns:
- a
ConditionMessage.Builder
builder - See Also:
-
empty
Factory method to return a new emptyConditionMessage
.- Returns:
- a new empty
ConditionMessage
-
of
Factory method to create a newConditionMessage
with a specific message.- Parameters:
message
- the source message (may be a format string ifargs
are specified)args
- format arguments for the message- Returns:
- a new
ConditionMessage
instance
-
of
Factory method to create a newConditionMessage
comprised of the specified messages.- Parameters:
messages
- the source messages (may benull
)- 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 newConditionMessage
for a condition.- Parameters:
condition
- the conditiondetails
- details of the condition- Returns:
- a
ConditionMessage.Builder
builder - See Also:
-
forCondition
Factory method for a builder to construct a newConditionMessage
for a condition.- Parameters:
condition
- the conditiondetails
- details of the condition- Returns:
- a
ConditionMessage.Builder
builder - See Also:
-