software.amazon.awscdk.core

Class Token

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Token

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-27T16:27:54.135Z")
public class Token
extends software.amazon.jsii.JsiiObject

Represents a special or lazily-evaluated value.

Can be used to delay evaluation of a certain value in case, for example, that it requires some context or late-bound data. Can also be used to mark values that need special processing at document rendering time.

Tokens can be embedded into strings while retaining their original semantics.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Token(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Token(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IResolvable	asAny(java.lang.Object value) Return a resolvable representation of the given value.
static java.util.List<java.lang.String>	asList(java.lang.Object value) Return a reversible list representation of this token.
static java.util.List<java.lang.String>	asList(java.lang.Object value, EncodingOptions options) Return a reversible list representation of this token.
static java.lang.Number	asNumber(java.lang.Object value) Return a reversible number representation of this token.
static java.lang.String	asString(java.lang.Object value) Return a reversible string representation of this token.
static java.lang.String	asString(java.lang.Object value, EncodingOptions options) Return a reversible string representation of this token.
static TokenComparison	compareStrings(java.lang.String possibleToken1, java.lang.String possibleToken2) Compare two strings that might contain Tokens with each other.
static java.lang.Boolean	isUnresolved(java.lang.Object obj) Returns true if obj represents an unresolved value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Token

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

Token

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

Method Detail

asAny

public static IResolvable asAny(java.lang.Object value)

Return a resolvable representation of the given value.

Parameters:

value - This parameter is required.

asList

public static java.util.List<java.lang.String> asList(java.lang.Object value,
                                                      EncodingOptions options)

Return a reversible list representation of this token.

Parameters:

value - This parameter is required.

options -

asList

public static java.util.List<java.lang.String> asList(java.lang.Object value)

Return a reversible list representation of this token.

Parameters:

value - This parameter is required.

asNumber

public static java.lang.Number asNumber(java.lang.Object value)

Return a reversible number representation of this token.

Parameters:

value - This parameter is required.

asString

public static java.lang.String asString(java.lang.Object value,
                                        EncodingOptions options)

Return a reversible string representation of this token.

If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings.

Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Parameters:

value - This parameter is required.

options -

asString

public static java.lang.String asString(java.lang.Object value)

Return a reversible string representation of this token.

If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings.

Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Parameters:

value - This parameter is required.

compareStrings

public static TokenComparison compareStrings(java.lang.String possibleToken1,
                                             java.lang.String possibleToken2)

Compare two strings that might contain Tokens with each other.

Parameters:

possibleToken1 - This parameter is required.

possibleToken2 - This parameter is required.

isUnresolved

public static java.lang.Boolean isUnresolved(java.lang.Object obj)

Returns true if obj represents an unresolved value.

One of these must be true:

• obj is an IResolvable
• obj is a string containing at least one encoded IResolvable
• obj is either an encoded number or list

This does NOT recurse into lists or objects to see if they containing resolvables.

Parameters:

obj - The object to test. This parameter is required.