com.atlassian.confluence.api.model.validation

Interface ValidationResult

All Known Subinterfaces:

MergeValidationResult

All Known Implementing Classes:

RestValidationResult, SimpleMergeValidationResult, SimpleValidationResult

@ExperimentalApi
public interface ValidationResult

Stores the results after an API Service validateX() method is called.

Method Summary

Modifier and Type	Method and Description
default ServiceException	convertToServiceException(String errorMsg) Converts this validation result into a ServiceException without throwing.
Iterable<ValidationError>	getErrors() Returns an iterable of the errors (if any) stored in this result.
boolean	isAllowedInReadOnlyMode() Checks for allowedInReadOnlyMode status.
boolean	isAuthorized() Checks for authorization status.
default boolean	isNotSuccessful() Just a convenience method.
default boolean	isSuccessful() Checks for both: validity and authorization.
default boolean	isValid() Checks for validity.
default ServiceException	throwIfInvalid() Deprecated. since 5.10 please use throwIfNotSuccessful()
default ServiceException	throwIfInvalid(String msg) Deprecated. since 5.10 please use throwIfNotSuccessful(String)
default void	throwIfNotSuccessful() Converts this validation result into a ServiceException and throws it.
default void	throwIfNotSuccessful(String msg) Converts this validation result into a ServiceException and throws it.
default void	throwIfNotValid(String msg) Deprecated. since 5.10 please use throwIfNotSuccessful(String)

Method Detail

isAuthorized

boolean isAuthorized()

Checks for authorization status. Does NOT imply the validity check.

Returns:

true if the current user is permitted to perform the execution that the validation is for, false otherwise.

See Also:

isValid(), isSuccessful()

isAllowedInReadOnlyMode

boolean isAllowedInReadOnlyMode()

Checks for allowedInReadOnlyMode status. Does NOT imply the validity check.

Returns:

true if the current user is allowed to perform the execution in read-only mode that the validation is for, false otherwise.

Since:

6.8.0

See Also:

isValid(), isSuccessful()

isValid

default boolean isValid()

Checks for validity. Does NOT imply the authorization check.

By contract implementations MUST return false if there are errors in this ValidationResult. Default implementation is usually enough.

Returns:

true if there are no errors in this result, false otherwise.

See Also:

getErrors(), isAuthorized(), isSuccessful()

getErrors

Iterable<ValidationError> getErrors()

Returns an iterable of the errors (if any) stored in this result. By contract having any errors here MUST also result in isValid() returning false.

Default implementation of isValid() is safe for null values. Be cautious about returning null if not using the default implementation for isValid().

Returns:

an iterable of the errors stored in this result.

See Also:

isValid(), ValidationError

isSuccessful

default boolean isSuccessful()

Checks for both: validity and authorization. If we would have any other boolean condition(s) here in the future, default implementation will also check for that one(s) as well.

By contract implementations MUST return true only when all the possible ValidationResult checks are true. Having any of the checks return false means this method should also return false.

Default implementation is usually enough.

Returns:

true in case this validationResult is both valid AND authorized, false otherwise

See Also:

isValid(), isAuthorized()

isNotSuccessful

default boolean isNotSuccessful()

Just a convenience method. Defaults to the negation of isSuccessful()

By contract implementations MUST return negation of the isSuccessful().

Returns:

negation of isSuccessful()

See Also:

isSuccessful()

throwIfInvalid

@Deprecated
default ServiceException throwIfInvalid(String msg)
                                             throws ServiceException

Deprecated. since 5.10 please use throwIfNotSuccessful(String)

Converts this validation result into a ServiceException and throws it. Checks for both: isValid() and isAuthorized().

Issues:

• Should always throw and never return anything, even though return type is declared.
• Method name suggests only validation check even though two checks are actually performed.

Deprecated for the reasons above.

This method is deprecated since 5.10, please use throwIfNotSuccessful(String)

Returns:

the exception that will be thrown

Throws:

ServiceException

See Also:

throwIfNotSuccessful(String)

throwIfNotValid

@Deprecated
default void throwIfNotValid(String msg)
                                  throws ServiceException

Deprecated. since 5.10 please use throwIfNotSuccessful(String)

Converts this validation result into a ServiceException and throws it. Checks for both: isValid() and isAuthorized().

Issues:

• Method name suggests only validation check even though two checks are actually performed.

Deprecated for the reason above.

This method is deprecated since 5.10, please use throwIfNotSuccessful(String)

Throws:

ServiceException

See Also:

throwIfNotSuccessful(String)

throwIfInvalid

@Deprecated
default ServiceException throwIfInvalid()
                                             throws ServiceException

Deprecated. since 5.10 please use throwIfNotSuccessful()

Converts this validation result into an Exception and throws it. Should always throw and never return anything, even though return type is declared. Deprecated for that reason.

First validation error will be used as message string

This method is deprecated since 5.10, please use throwIfNotSuccessful()

Returns:

the exception that will be thrown

Throws:

ServiceException

See Also:

throwIfNotSuccessful()

convertToServiceException

default ServiceException convertToServiceException(@Nullable
                                                   String errorMsg)

Converts this validation result into a ServiceException without throwing. Implementations of this method should reasonably analyze the internals of this ValidationResult and return appropriate subclass of ServiceException which is most suitable for the case.

This method is used internally in the default implementations of throwIfNotSuccessful() and throwIfNotSuccessful(String)

Parameters:

errorMsg - message to put in the Exception returned

Returns:

instance of appropriate ServiceException subclass.

See Also:

throwIfNotSuccessful(), throwIfNotSuccessful(String)

throwIfNotSuccessful

default void throwIfNotSuccessful(String msg)
                           throws ServiceException

Converts this validation result into a ServiceException and throws it. By default provided string will be used as an exception message.

By contract implementations MUST throw proper subclass of ServiceException when isNotSuccessful().

Throws:

ServiceException

See Also:

isNotSuccessful(), convertToServiceException(String)

throwIfNotSuccessful

default void throwIfNotSuccessful()
                           throws ServiceException

Converts this validation result into a ServiceException and throws it.

By default first validation error (if any) will be used as an exception message.

By contract implementations MUST throw proper subclass of ServiceException when isNotSuccessful().

Throws:

ServiceException

See Also:

isNotSuccessful(), convertToServiceException(String), getErrors(), ValidationError