org.controlsfx.validation

Class ValidationResult

java.lang.Object

org.controlsfx.validation.ValidationResult

public class ValidationResult
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
ValidationResult() Creates empty validation result

Method Summary

Modifier and Type	Method and Description
ValidationResult	add(ValidationMessage message) Add one message to validation result.
ValidationResult	addAll(java.util.Collection<? extends ValidationMessage> messages) Add collection of validation messages.
ValidationResult	addAll(ValidationMessage... messages) Add several validation messages.
ValidationResult	addErrorIf(javafx.scene.control.Control target, java.lang.String text, boolean condition) Add one error to validation result with condition
ValidationResult	addInfoIf(javafx.scene.control.Control target, java.lang.String text, boolean condition) Add one info to validation result with condition
ValidationResult	addMessageIf(javafx.scene.control.Control target, java.lang.String text, Severity severity, boolean condition) Add one message to validation result with condition.
ValidationResult	addWarningIf(javafx.scene.control.Control target, java.lang.String text, boolean condition) Add one warning to validation result with condition
ValidationResult	combine(ValidationResult validationResult) Combine validation result with another.
ValidationResult	combineAll(java.util.Collection<ValidationResult> validationResults) Combine validation result with others.
ValidationResult	combineAll(ValidationResult... validationResults) Combine validation result with others.
ValidationResult	copy() Creates a copy of validation result
static ValidationResult	fromError(javafx.scene.control.Control target, java.lang.String text) Factory method to create validation result out of one error
static ValidationResult	fromErrorIf(javafx.scene.control.Control target, java.lang.String text, boolean condition) Factory method to create validation result out of one error
static ValidationResult	fromInfo(javafx.scene.control.Control target, java.lang.String text) Factory method to create validation result out of one info
static ValidationResult	fromInfoIf(javafx.scene.control.Control target, java.lang.String text, boolean condition) Factory method to create validation result out of one info
static ValidationResult	fromMessageIf(javafx.scene.control.Control target, java.lang.String text, Severity severity, boolean condition) Factory method to create validation result out of one message.
static ValidationResult	fromMessages(java.util.Collection<? extends ValidationMessage> messages) Factory method to create validation result out of collection of messages
static ValidationResult	fromMessages(ValidationMessage... messages) Factory method to create validation result out of several messages
static ValidationResult	fromResults(java.util.Collection<ValidationResult> results) Factory method to create validation result out of collection of validation results
static ValidationResult	fromResults(ValidationResult... results) Factory method to create validation result out of several validation results
static ValidationResult	fromWarning(javafx.scene.control.Control target, java.lang.String text) Factory method to create validation result out of one warning
static ValidationResult	fromWarningIf(javafx.scene.control.Control target, java.lang.String text, boolean condition) Factory method to create validation result out of one warning
java.util.Collection<ValidationMessage>	getErrors() Retrieve errors represented by validation result
java.util.Collection<ValidationMessage>	getInfos() Retrieve infos represented by validation result
java.util.Collection<ValidationMessage>	getMessages() Retrieve all messages represented by validation result
java.util.Collection<ValidationMessage>	getWarnings() Retrieve warnings represented by validation result

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValidationResult

public ValidationResult()

Creates empty validation result

Method Detail

fromMessageIf

public static final ValidationResult fromMessageIf(javafx.scene.control.Control target,
                                                   java.lang.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 - validation target

text - message text

severity - message severity

condition - condition on which message will be added to validation result

Returns:

New instance of validation result

fromErrorIf

public static final ValidationResult fromErrorIf(javafx.scene.control.Control target,
                                                 java.lang.String text,
                                                 boolean condition)

Factory method to create validation result out of one error

Parameters:

target - validation target

text - message text

condition - condition on which message will be added to validation result

Returns:

New instance of validation result

fromWarningIf

public static final ValidationResult fromWarningIf(javafx.scene.control.Control target,
                                                   java.lang.String text,
                                                   boolean condition)

Factory method to create validation result out of one warning

Parameters:

target - validation target

text - message text

condition - condition on which message will be added to validation result

Returns:

New instance of validation result

fromInfoIf

public static final ValidationResult fromInfoIf(javafx.scene.control.Control target,
                                                java.lang.String text,
                                                boolean condition)

Factory method to create validation result out of one info

Parameters:

target - validation target

text - message text

condition - condition on which message will be added to validation result

Returns:

New instance of validation result

fromError

public static final ValidationResult fromError(javafx.scene.control.Control target,
                                               java.lang.String text)

Factory method to create validation result out of one error

Parameters:

target - validation target

text - message text

Returns:

New instance of validation result

fromWarning

public static final ValidationResult fromWarning(javafx.scene.control.Control target,
                                                 java.lang.String text)

Factory method to create validation result out of one warning

Parameters:

target - validation target

text - message text

Returns:

New instance of validation result

fromInfo

public static final ValidationResult fromInfo(javafx.scene.control.Control target,
                                              java.lang.String text)

Factory method to create validation result out of one info

Parameters:

target - validation target

text - message text

Returns:

New instance of validation result

fromMessages

public static final ValidationResult fromMessages(ValidationMessage... messages)

Factory method to create validation result out of several messages

Parameters:

messages -

Returns:

New instance of validation result

fromMessages

public static final ValidationResult fromMessages(java.util.Collection<? extends ValidationMessage> messages)

Factory method to create validation result out of collection of messages

Parameters:

messages -

Returns:

New instance of validation result

fromResults

public static final ValidationResult fromResults(ValidationResult... results)

Factory method to create validation result out of several validation results

Parameters:

results - results

Returns:

New instance of validation result, combining all into one

fromResults

public static final ValidationResult fromResults(java.util.Collection<ValidationResult> results)

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

Parameters:

results - results

Returns:

New instance of validation result, combining all into one

copy

public ValidationResult copy()

Creates a copy of validation result

Returns:

copy of validation result

add

public ValidationResult add(ValidationMessage message)

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

Parameters:

message - validation message

Returns:

updated validation result

addMessageIf

public ValidationResult addMessageIf(javafx.scene.control.Control target,
                                     java.lang.String text,
                                     Severity severity,
                                     boolean condition)

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

Parameters:

target - validation target

text - message text

severity - message severity

condition - condition on which message will be added

Returns:

updated validation result

addErrorIf

public ValidationResult addErrorIf(javafx.scene.control.Control target,
                                   java.lang.String text,
                                   boolean condition)

Add one error to validation result with condition

Parameters:

target - validation target

text - message text

condition - condition on which error will be added

Returns:

updated validation result

addWarningIf

public ValidationResult addWarningIf(javafx.scene.control.Control target,
                                     java.lang.String text,
                                     boolean condition)

Add one warning to validation result with condition

Parameters:

target - validation target

text - message text

condition - condition on which warning will be added

Returns:

updated validation result

addInfoIf

public ValidationResult addInfoIf(javafx.scene.control.Control target,
                                  java.lang.String text,
                                  boolean condition)

Add one info to validation result with condition

Parameters:

target - validation target

text - message text

condition - condition on which info will be added

Returns:

updated validation result

addAll

public ValidationResult addAll(java.util.Collection<? extends ValidationMessage> messages)

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

Parameters:

messages -

Returns:

updated validation result

addAll

public ValidationResult addAll(ValidationMessage... messages)

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

Parameters:

messages -

Returns:

updated validation result

combine

public ValidationResult combine(ValidationResult validationResult)

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

Parameters:

validationResult -

Returns:

new instance of combined validation result

combineAll

public ValidationResult combineAll(java.util.Collection<ValidationResult> validationResults)

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

Parameters:

validationResults -

Returns:

new instance of combined validation result

combineAll

public ValidationResult combineAll(ValidationResult... validationResults)

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

Parameters:

validationResults -

Returns:

new instance of combined validation result

getErrors

public java.util.Collection<ValidationMessage> getErrors()

Retrieve errors represented by validation result

Returns:

an unmodifiable collection of errors

getWarnings

public java.util.Collection<ValidationMessage> getWarnings()

Retrieve warnings represented by validation result

Returns:

an unmodifiable collection of warnings

getInfos

public java.util.Collection<ValidationMessage> getInfos()

Retrieve infos represented by validation result

Returns:

an unmodifiable collection of infos

getMessages

public java.util.Collection<ValidationMessage> getMessages()

Retrieve all messages represented by validation result

Returns:

an unmodifiable collection of messages