Top Description Fields Constructors Methods
org.controlsfx.validation

public Class ValidationResult

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Arrays, .Collection, .Collections, .List, java.util.stream.Collectors, javafx.scene.control.Control

Validation result. Can generally be thought of a collection of validation messages. Allows for quick an painless accumulation of the messages. Also provides ability to combine validation results

Field Summary

Modifier and TypeField and Description
private List<ValidationMessage>

Constructor Summary

AccessConstructor and Description
public
ValidationResult()

Creates empty validation result

Method Summary

Modifier and TypeMethod and Description
public ValidationResult

Returns:

updated validation result
add
(ValidationMessage
validation message
message
)

Add one message to validation result.

public ValidationResult

Returns:

updated validation result
addAll
(Collection<? extends ValidationMessage> messages)

Add collection of validation messages.

public ValidationResult

Returns:

updated validation result
addAll
(ValidationMessage... messages)

Add several validation messages.

public ValidationResult

Returns:

updated validation result
addErrorIf
(Control
validation target
target
,
String
message text
text
,
boolean
condition on which error will be added
condition
)

Add one error to validation result with condition

public ValidationResult

Returns:

updated validation result
addInfoIf
(Control
validation target
target
,
String
message text
text
,
boolean
condition on which info will be added
condition
)

Add one info to validation result with condition

public ValidationResult

Returns:

updated validation result
addMessageIf
(Control
validation target
target
,
String
message text
text
,
Severity
message severity
severity
,
boolean
condition on which message will be added
condition
)

Add one message to validation result with condition.

public ValidationResult

Returns:

updated validation result
addWarningIf
(Control
validation target
target
,
String
message text
text
,
boolean
condition on which warning will be added
condition
)

Add one warning to validation result with condition

public ValidationResult

Returns:

new instance of combined validation result
combine
(ValidationResult validationResult)

Combine validation result with another.

public ValidationResult

Returns:

new instance of combined validation result
combineAll
(Collection<ValidationResult> validationResults)

Combine validation result with others.

public ValidationResult

Returns:

new instance of combined validation result
combineAll
(ValidationResult... validationResults)

Combine validation result with others.

public ValidationResult

Returns:

copy of validation result
copy
()

Creates a copy of validation result

public static final ValidationResult

Returns:

New instance of validation result
fromError
(Control
validation target
target
,
String
message text
text
)

Factory method to create validation result out of one error

public static final ValidationResult

Returns:

New instance of validation result
fromErrorIf
(Control
validation target
target
,
String
message text
text
,
boolean
condition on which message will be added to validation result
condition
)

Factory method to create validation result out of one error

public static final ValidationResult

Returns:

New instance of validation result
fromInfo
(Control
validation target
target
,
String
message text
text
)

Factory method to create validation result out of one info

public static final ValidationResult

Returns:

New instance of validation result
fromInfoIf
(Control
validation target
target
,
String
message text
text
,
boolean
condition on which message will be added to validation result
condition
)

Factory method to create validation result out of one info

public static final ValidationResult

Returns:

New instance of validation result
fromMessageIf
(Control
validation target
target
,
String
message text
text
,
Severity
message severity
severity
,
boolean
condition on which message will be added to validation result
condition
)

Factory method to create validation result out of one message.

public static final ValidationResult

Returns:

New instance of validation result
fromMessages
(ValidationMessage... messages)

Factory method to create validation result out of several messages

public static final ValidationResult

Returns:

New instance of validation result
fromMessages
(Collection<? extends ValidationMessage> messages)

Factory method to create validation result out of collection of messages

public static final ValidationResult

Returns:

New instance of validation result, combining all into one
fromResults
(ValidationResult...
results
results
)

Factory method to create validation result out of several validation results

public static final ValidationResult

Returns:

New instance of validation result, combining all into one
fromResults
(Collection<ValidationResult>
results
results
)

Factory method to create validation result out of collection of validation results

public static final ValidationResult

Returns:

New instance of validation result
fromWarning
(Control
validation target
target
,
String
message text
text
)

Factory method to create validation result out of one warning

public static final ValidationResult

Returns:

New instance of validation result
fromWarningIf
(Control
validation target
target
,
String
message text
text
,
boolean
condition on which message will be added to validation result
condition
)

Factory method to create validation result out of one warning

public Collection<ValidationMessage>

Returns:

an unmodifiable collection of errors
getErrors
()

Retrieve errors represented by validation result

public Collection<ValidationMessage>

Returns:

an unmodifiable collection of infos
getInfos
()

Retrieve infos represented by validation result

public Collection<ValidationMessage>

Returns:

an unmodifiable collection of messages
getMessages
()

Retrieve all messages represented by validation result

private Collection<ValidationMessage>

Returns:

an unmodifiable collection of messages
getMessages
(Severity severity)

Helper method to get all messages for a given severity.

public Collection<ValidationMessage>

Returns:

an unmodifiable collection of warnings
getWarnings
()

Retrieve warnings represented by validation result

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

invalidMessagesback to summary
private List<ValidationMessage> invalidMessages

Constructor Detail

ValidationResultback to summary
public ValidationResult()

Creates empty validation result

Method Detail

addback to summary
public ValidationResult add(ValidationMessage message)

Add one message to validation result. Messages with Severity#OK will be ignored.

Parameters
message:ValidationMessage

validation message

Returns:ValidationResult

updated validation result

addAllback to summary
public ValidationResult addAll(Collection<? extends ValidationMessage> messages)

Add collection of validation messages. Messages with Severity#OK will be ignored.

Returns:ValidationResult

updated validation result

addAllback to summary
public ValidationResult addAll(ValidationMessage... messages)

Add several validation messages. Messages with Severity#OK will be ignored.

Returns:ValidationResult

updated validation result

addErrorIfback to summary
public ValidationResult addErrorIf(Control target, String text, boolean condition)

Add one error to validation result with condition

Parameters
target:Control

validation target

text:String

message text

condition:boolean

condition on which error will be added

Returns:ValidationResult

updated validation result

addInfoIfback to summary
public ValidationResult addInfoIf(Control target, String text, boolean condition)

Add one info to validation result with condition

Parameters
target:Control

validation target

text:String

message text

condition:boolean

condition on which info will be added

Returns:ValidationResult

updated validation result

addMessageIfback to summary
public ValidationResult addMessageIf(Control target, String text, Severity severity, boolean condition)

Add one message to validation result with condition. Messages with Severity#OK will be ignored.

Parameters
target:Control

validation target

text:String

message text

severity:Severity

message severity

condition:boolean

condition on which message will be added

Returns:ValidationResult

updated validation result

addWarningIfback to summary
public ValidationResult addWarningIf(Control target, String text, boolean condition)

Add one warning to validation result with condition

Parameters
target:Control

validation target

text:String

message text

condition:boolean

condition on which warning will be added

Returns:ValidationResult

updated validation result

combineback to summary
public ValidationResult combine(ValidationResult validationResult)

Combine validation result with another. This will create a new instance of combined validation result

Returns:ValidationResult

new instance of combined validation result

combineAllback to summary
public ValidationResult combineAll(Collection<ValidationResult> validationResults)

Combine validation result with others. This will create a new instance of combined validation result

Returns:ValidationResult

new instance of combined validation result

combineAllback to summary
public ValidationResult combineAll(ValidationResult... validationResults)

Combine validation result with others. This will create a new instance of combined validation result

Returns:ValidationResult

new instance of combined validation result

copyback to summary
public ValidationResult copy()

Creates a copy of validation result

Returns:ValidationResult

copy of validation result

fromErrorback to summary
public static final ValidationResult fromError(Control target, String text)

Factory method to create validation result out of one error

Parameters
target:Control

validation target

text:String

message text

Returns:ValidationResult

New instance of validation result

fromErrorIfback to summary
public static final ValidationResult fromErrorIf(Control target, String text, boolean condition)

Factory method to create validation result out of one error

Parameters
target:Control

validation target

text:String

message text

condition:boolean

condition on which message will be added to validation result

Returns:ValidationResult

New instance of validation result

fromInfoback to summary
public static final ValidationResult fromInfo(Control target, String text)

Factory method to create validation result out of one info

Parameters
target:Control

validation target

text:String

message text

Returns:ValidationResult

New instance of validation result

fromInfoIfback to summary
public static final ValidationResult fromInfoIf(Control target, String text, boolean condition)

Factory method to create validation result out of one info

Parameters
target:Control

validation target

text:String

message text

condition:boolean

condition on which message will be added to validation result

Returns:ValidationResult

New instance of validation result

fromMessageIfback to summary
public static final ValidationResult fromMessageIf(Control target, String text, Severity severity, boolean condition)

Factory method to create validation result out of one message. Messages with Severity#OK will be ignored.

Parameters
target:Control

validation target

text:String

message text

severity:Severity

message severity

condition:boolean

condition on which message will be added to validation result

Returns:ValidationResult

New instance of validation result

fromMessagesback to summary
public static final ValidationResult fromMessages(ValidationMessage... messages)

Factory method to create validation result out of several messages

Returns:ValidationResult

New instance of validation result

fromMessagesback to summary
public static final ValidationResult fromMessages(Collection<? extends ValidationMessage> messages)

Factory method to create validation result out of collection of messages

Returns:ValidationResult

New instance of validation result

fromResultsback to summary
public static final ValidationResult fromResults(ValidationResult... results)

Factory method to create validation result out of several validation results

Parameters
results:ValidationResult[]

results

Returns:ValidationResult

New instance of validation result, combining all into one

fromResultsback to summary
public static final ValidationResult fromResults(Collection<ValidationResult> results)

Factory method to create validation result out of collection of validation results

Parameters
results:Collection<ValidationResult>

results

Returns:ValidationResult

New instance of validation result, combining all into one

fromWarningback to summary
public static final ValidationResult fromWarning(Control target, String text)

Factory method to create validation result out of one warning

Parameters
target:Control

validation target

text:String

message text

Returns:ValidationResult

New instance of validation result

fromWarningIfback to summary
public static final ValidationResult fromWarningIf(Control target, String text, boolean condition)

Factory method to create validation result out of one warning

Parameters
target:Control

validation target

text:String

message text

condition:boolean

condition on which message will be added to validation result

Returns:ValidationResult

New instance of validation result

getErrorsback to summary
public Collection<ValidationMessage> getErrors()

Retrieve errors represented by validation result

Returns:Collection<ValidationMessage>

an unmodifiable collection of errors

getInfosback to summary
public Collection<ValidationMessage> getInfos()

Retrieve infos represented by validation result

Returns:Collection<ValidationMessage>

an unmodifiable collection of infos

getMessagesback to summary
public Collection<ValidationMessage> getMessages()

Retrieve all messages represented by validation result

Returns:Collection<ValidationMessage>

an unmodifiable collection of messages

getMessagesback to summary
private Collection<ValidationMessage> getMessages(Severity severity)

Helper method to get all messages for a given severity. A null severity will return all messages.

Returns:Collection<ValidationMessage>

an unmodifiable collection of messages

getWarningsback to summary
public Collection<ValidationMessage> getWarnings()

Retrieve warnings represented by validation result

Returns:Collection<ValidationMessage>

an unmodifiable collection of warnings