com.atlassian.confluence.api.model.validation

Class SimpleValidationResult

java.lang.Object

com.atlassian.confluence.api.model.validation.SimpleValidationResult

All Implemented Interfaces:

ValidationResult

public class SimpleValidationResult
extends Object
implements ValidationResult

Represents the simplest kind of ValidationResult.

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleValidationResult.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ValidationResult	FORBIDDEN A singleton unauthorized result.
static ValidationResult	VALID A singleton valid result.

Method Summary

Modifier and Type	Method and Description
static SimpleValidationResult.Builder	builder()
ServiceException	convertToServiceException(String errorMsg)
Collection<ValidationError>	getErrors()
boolean	isAuthorized()
boolean	isValid()
ServiceException	throwIfInvalid() converts this validation result into an Exception and throws it
ServiceException	throwIfInvalid(String message) converts this validation result into an Exception and throws it
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VALID

public static final ValidationResult VALID

A singleton valid result.

FORBIDDEN

public static final ValidationResult FORBIDDEN

A singleton unauthorized result.

Method Detail

isAuthorized

public boolean isAuthorized()

Specified by:

isAuthorized in interface ValidationResult

Returns:

true if the current user is permitted to perform the execution that the validation is for

isValid

public boolean isValid()

Specified by:

isValid in interface ValidationResult

Returns:

true if there are no errors in this result

getErrors

public Collection<ValidationError> getErrors()

Specified by:

getErrors in interface ValidationResult

Returns:

an iterable of the errors stored in this result

throwIfInvalid

public ServiceException throwIfInvalid(String message)
                                throws ServiceException

Description copied from interface: ValidationResult

converts this validation result into an Exception and throws it

Specified by:

throwIfInvalid in interface ValidationResult

Returns:

the exception that will be thrown

Throws:

ServiceException

throwIfInvalid

public ServiceException throwIfInvalid()
                                throws ServiceException

Description copied from interface: ValidationResult

converts this validation result into an Exception and throws it

first validation error will be used as message string

Specified by:

throwIfInvalid in interface ValidationResult

Returns:

the exception that will be thrown

All implementations do not conform to specifications and return null. Either the implementation or the javadoc needs to be updated.

Throws:

ServiceException

convertToServiceException

public ServiceException convertToServiceException(String errorMsg)

toString

public String toString()

Overrides:

toString in class Object

builder

public static SimpleValidationResult.Builder builder()