Class SimpleMergeValidationResult
- java.lang.Object
-
- com.atlassian.confluence.api.model.validation.SimpleMergeValidationResult
-
- All Implemented Interfaces:
MergeValidationResult
,ValidationResult
public class SimpleMergeValidationResult extends Object implements MergeValidationResult
- Since:
- 5.9
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SimpleMergeValidationResult.Builder
-
Constructor Summary
Constructors Constructor Description SimpleMergeValidationResult(SimpleMergeValidationResult.Builder builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static SimpleMergeValidationResult.Builder
builder(ValidationResult result)
ServiceException
convertToServiceException(@Nullable String errorMsg)
Converts this validation result into aServiceException
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.boolean
isValid()
Checks for validity.ServiceException
throwIfInvalid()
Deprecated.since 5.10 please usethrowIfNotSuccessful()
ServiceException
throwIfInvalid(String msg)
Deprecated.since 5.10 please usethrowIfNotSuccessful(String)
void
throwIfNotSuccessful()
Converts this validation result into aServiceException
and throws it.void
throwIfNotSuccessful(String msg)
Converts this validation result into aServiceException
and throws it.void
throwIfNotValid(String msg)
Deprecated.since 5.10 please usethrowIfNotSuccessful(String)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.atlassian.confluence.api.model.validation.ValidationResult
isNotSuccessful, isSuccessful
-
-
-
-
Constructor Detail
-
SimpleMergeValidationResult
public SimpleMergeValidationResult(SimpleMergeValidationResult.Builder builder)
-
-
Method Detail
-
isAuthorized
public boolean isAuthorized()
Description copied from interface:ValidationResult
Checks for authorization status. Does NOT imply thevalidity check
.- Specified by:
isAuthorized
in interfaceValidationResult
- Returns:
true
if the current user is permitted to perform the execution that the validation is for,false
otherwise.- See Also:
ValidationResult.isValid()
,ValidationResult.isSuccessful()
-
isAllowedInReadOnlyMode
public boolean isAllowedInReadOnlyMode()
Description copied from interface:ValidationResult
Checks for allowedInReadOnlyMode status. Does NOT imply thevalidity check
.- Specified by:
isAllowedInReadOnlyMode
in interfaceValidationResult
- Returns:
true
if the current user is allowed to perform the execution in read-only mode that the validation is for,false
otherwise.- See Also:
ValidationResult.isValid()
,ValidationResult.isSuccessful()
-
isValid
public boolean isValid()
Description copied from interface:ValidationResult
Checks for validity. Does NOT imply theauthorization check
.By contract implementations MUST return
false
if there are errors in this ValidationResult. Default implementation is usually enough.- Specified by:
isValid
in interfaceValidationResult
- Returns:
true
if there are no errors in this result,false
otherwise.- See Also:
ValidationResult.getErrors()
,ValidationResult.isAuthorized()
,ValidationResult.isSuccessful()
-
getErrors
public Iterable<ValidationError> getErrors()
Description copied from interface:ValidationResult
Returns an iterable of the errors (if any) stored in this result. By contract having any errors here MUST also result inValidationResult.isValid()
returningfalse
.Default implementation of
ValidationResult.isValid()
is safe fornull
values. Be cautious about returningnull
if not using the default implementation forValidationResult.isValid()
.- Specified by:
getErrors
in interfaceValidationResult
- Returns:
- an iterable of the errors stored in this result.
- See Also:
ValidationResult.isValid()
,ValidationError
-
throwIfInvalid
@Deprecated public ServiceException throwIfInvalid(String msg) throws ServiceException
Deprecated.since 5.10 please usethrowIfNotSuccessful(String)
Description copied from interface:ValidationResult
Converts this validation result into aServiceException
and throws it. Checks for both:ValidationResult.isValid()
andValidationResult.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.
This method is deprecated since 5.10, please use
ValidationResult.throwIfNotSuccessful(String)
- Specified by:
throwIfInvalid
in interfaceValidationResult
- Returns:
- the exception that will be thrown
- Throws:
ServiceException
- See Also:
ValidationResult.throwIfNotSuccessful(String)
-
throwIfNotValid
@Deprecated public void throwIfNotValid(String msg) throws ServiceException
Deprecated.since 5.10 please usethrowIfNotSuccessful(String)
Description copied from interface:ValidationResult
Converts this validation result into aServiceException
and throws it. Checks for both:ValidationResult.isValid()
andValidationResult.isAuthorized()
.Issues:
- Method name suggests only validation check even though two checks are actually performed.
This method is deprecated since 5.10, please use
ValidationResult.throwIfNotSuccessful(String)
- Specified by:
throwIfNotValid
in interfaceValidationResult
- Throws:
ServiceException
- See Also:
ValidationResult.throwIfNotSuccessful(String)
-
throwIfInvalid
@Deprecated public ServiceException throwIfInvalid() throws ServiceException
Deprecated.since 5.10 please usethrowIfNotSuccessful()
Description copied from interface:ValidationResult
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
ValidationResult.throwIfNotSuccessful()
- Specified by:
throwIfInvalid
in interfaceValidationResult
- Returns:
- the exception that will be thrown
- Throws:
ServiceException
- See Also:
ValidationResult.throwIfNotSuccessful()
-
throwIfNotSuccessful
public void throwIfNotSuccessful(String msg) throws ServiceException
Description copied from interface:ValidationResult
Converts this validation result into aServiceException
and throws it. By default provided string will be used as an exception message.By contract implementations MUST throw proper subclass of
ServiceException
whenValidationResult.isNotSuccessful()
.- Specified by:
throwIfNotSuccessful
in interfaceValidationResult
- Throws:
ServiceException
- See Also:
ValidationResult.isNotSuccessful()
,ValidationResult.convertToServiceException(String)
-
throwIfNotSuccessful
public void throwIfNotSuccessful() throws ServiceException
Description copied from interface:ValidationResult
Converts this validation result into aServiceException
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
whenValidationResult.isNotSuccessful()
.- Specified by:
throwIfNotSuccessful
in interfaceValidationResult
- Throws:
ServiceException
- See Also:
ValidationResult.isNotSuccessful()
,ValidationResult.convertToServiceException(String)
,ValidationResult.getErrors()
,ValidationError
-
convertToServiceException
public ServiceException convertToServiceException(@Nullable String errorMsg)
Description copied from interface:ValidationResult
Converts this validation result into aServiceException
without throwing. Implementations of this method should reasonably analyze the internals of this ValidationResult and return appropriate subclass ofServiceException
which is most suitable for the case.This method is used internally in the default implementations of
ValidationResult.throwIfNotSuccessful()
andValidationResult.throwIfNotSuccessful(String)
- Specified by:
convertToServiceException
in interfaceValidationResult
- Parameters:
errorMsg
- message to put in the Exception returned- Returns:
- instance of appropriate
ServiceException
subclass. - See Also:
ValidationResult.throwIfNotSuccessful()
,ValidationResult.throwIfNotSuccessful(String)
-
builder
public static SimpleMergeValidationResult.Builder builder(ValidationResult result)
-
-