software.amazon.awscdk.assertions

Class Capture

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.assertions.Matcher

software.amazon.awscdk.assertions.Capture

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:49.466Z")
public class Capture
extends Matcher

Capture values while matching templates.

Using an instance of this class within a Matcher will capture the matching value. The as*() APIs on the instance can be used to get the captured value.

Example:

 // Given a template -
 // {
 //   "Resources": {
 //     "MyBar": {
 //       "Type": "Foo::Bar",
 //       "Properties": {
 //         "Fred": "Flob",
 //       }
 //     },
 //     "MyBaz": {
 //       "Type": "Foo::Bar",
 //       "Properties": {
 //         "Fred": "Quib",
 //       }
 //     }
 //   }
 // }
 Capture fredCapture = new Capture();
 template.hasResourceProperties("Foo::Bar", Map.of(
         "Fred", fredCapture));
 fredCapture.asString(); // returns "Flob"
 fredCapture.next(); // returns true
 fredCapture.asString();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
	Capture() Initialize a new capture.
protected	Capture(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Capture(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	asArray() Retrieve the captured value as an array.
java.lang.Boolean	asBoolean() Retrieve the captured value as a boolean.
java.lang.Number	asNumber() Retrieve the captured value as a number.
java.util.Map<java.lang.String,java.lang.Object>	asObject() Retrieve the captured value as a JSON object.
java.lang.String	asString() Retrieve the captured value as a string.
java.lang.String	getName() A name for the matcher.
java.lang.Boolean	next() When multiple results are captured, move the iterator to the next result.
MatchResult	test(java.lang.Object actual) Test whether a target matches the provided pattern.

Methods inherited from class software.amazon.awscdk.assertions.Matcher

isMatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

Capture

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

Capture

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

Capture

public Capture()

Initialize a new capture.

Method Detail

asArray

public java.util.List<java.lang.Object> asArray()

Retrieve the captured value as an array.

An error is generated if no value is captured or if the value is not an array.

asBoolean

public java.lang.Boolean asBoolean()

Retrieve the captured value as a boolean.

An error is generated if no value is captured or if the value is not a boolean.

asNumber

public java.lang.Number asNumber()

Retrieve the captured value as a number.

An error is generated if no value is captured or if the value is not a number.

asObject

public java.util.Map<java.lang.String,java.lang.Object> asObject()

Retrieve the captured value as a JSON object.

An error is generated if no value is captured or if the value is not an object.

asString

public java.lang.String asString()

Retrieve the captured value as a string.

An error is generated if no value is captured or if the value is not a string.

next

public java.lang.Boolean next()

When multiple results are captured, move the iterator to the next result.

Returns:

true if another capture is present, false otherwise

test

public MatchResult test(java.lang.Object actual)

Test whether a target matches the provided pattern.

Every Matcher must implement this method. This method will be invoked by the assertions framework. Do not call this method directly.

Specified by:

test in class Matcher

Parameters:

actual - This parameter is required.

Returns:

the list of match failures. An empty array denotes a successful match.

getName

public java.lang.String getName()

A name for the matcher.

This is collected as part of the result and may be presented to the user.

Specified by:

getName in class Matcher