software.amazon.awscdk.core

Class ValidationResult

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.ValidationResult

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:53.162Z")
public class ValidationResult
extends software.amazon.jsii.JsiiObject

Representation of validation results.

Models a tree of validation errors so that we have as much information as possible about the failure that occurred.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 ValidationResults validationResults;
 ValidationResult validationResult = new ValidationResult("errorMessage", validationResults);
 

Constructor Summary

Constructors

Modifier	Constructor and Description
	ValidationResult()
protected	ValidationResult(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ValidationResult(software.amazon.jsii.JsiiObjectRef objRef)
	ValidationResult(java.lang.String errorMessage, ValidationResults results)

Method Summary

Modifier and Type	Method and Description
void	assertSuccess() Turn a failed validation into an exception.
java.lang.String	errorTree() Return a string rendering of the tree of validation failures.
java.lang.String	getErrorMessage()
java.lang.Boolean	getIsSuccess()
ValidationResults	getResults()
ValidationResult	prefix(java.lang.String message) Wrap this result with an error message, if it concerns an error.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationResult

protected ValidationResult(software.amazon.jsii.JsiiObjectRef objRef)

ValidationResult

protected ValidationResult(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ValidationResult

public ValidationResult(java.lang.String errorMessage,
                        ValidationResults results)

Parameters:

errorMessage -

results -

ValidationResult

public ValidationResult()

Method Detail

assertSuccess

public void assertSuccess()

Turn a failed validation into an exception.

errorTree

public java.lang.String errorTree()

Return a string rendering of the tree of validation failures.

prefix

public ValidationResult prefix(java.lang.String message)

Wrap this result with an error message, if it concerns an error.

Parameters:

message - This parameter is required.

getErrorMessage

public java.lang.String getErrorMessage()

getIsSuccess

public java.lang.Boolean getIsSuccess()

getResults

public ValidationResults getResults()