Package software.amazon.smithy.rulesengine.aws.language.functions

Class IsVirtualHostableS3Bucket

java.lang.Object

software.amazon.smithy.rulesengine.language.syntax.SyntaxElement

software.amazon.smithy.rulesengine.language.syntax.expressions.Expression

software.amazon.smithy.rulesengine.language.syntax.expressions.functions.LibraryFunction

software.amazon.smithy.rulesengine.aws.language.functions.IsVirtualHostableS3Bucket

All Implemented Interfaces:

FromSourceLocation, ToNode, TypeCheck, ToCondition, ToExpression

public final class IsVirtualHostableS3Bucket
extends LibraryFunction

An AWS rule-set function for determining whether a given string can be promoted to an S3 virtual bucket host label.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IsVirtualHostableS3Bucket.Definition	A FunctionDefinition for the IsVirtualHostableS3Bucket function.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID

Fields inherited from class software.amazon.smithy.rulesengine.language.syntax.expressions.functions.LibraryFunction

definition, functionNode

Method Summary

Modifier and Type	Method	Description
<T> T	accept(ExpressionVisitor<T> visitor)	Invoke the ExpressionVisitor functions for this expression.
static IsVirtualHostableS3Bucket.Definition	getDefinition()	Gets the FunctionDefinition implementation.
static boolean	isVirtualHostableBucket(String hostLabel, boolean allowDots)	Checks if the given hostLabel string is a virtual hostable bucket name.
static IsVirtualHostableS3Bucket	ofExpressions(ToExpression arg1, boolean arg2)	Creates a IsVirtualHostableS3Bucket function from the given expressions.
static IsVirtualHostableS3Bucket	ofExpressions(ToExpression arg1, ToExpression arg2)	Creates a IsVirtualHostableS3Bucket function from the given expressions.

Methods inherited from class software.amazon.smithy.rulesengine.language.syntax.expressions.functions.LibraryFunction

calculateReferences, canonicalize, equals, expectOneArgument, getArguments, getFunctionDefinition, getName, getSourceLocation, hashCode, shouldSwapArgs, toConditionBuilder, toNode, toString, typeCheckLocal

Methods inherited from class software.amazon.smithy.rulesengine.language.syntax.expressions.Expression

fromNode, getLiteral, getReference, getReference, getReference, getReferences, of, of, of, parseShortform, toExpression, type, typeCheck

Methods inherited from class software.amazon.smithy.rulesengine.language.syntax.SyntaxElement

availableSince, booleanEqual, getAttr, getAttr, isSet, isValidHostLabel, not, parseUrl, stringEqual, substring, template

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.smithy.rulesengine.language.syntax.ToCondition

toCondition, toCondition

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Method Details

getDefinition

public static IsVirtualHostableS3Bucket.Definition getDefinition()

Gets the FunctionDefinition implementation.

Returns:

the function definition.

ofExpressions

public static IsVirtualHostableS3Bucket ofExpressions(ToExpression arg1,
 ToExpression arg2)

Creates a IsVirtualHostableS3Bucket function from the given expressions.

Parameters:

arg1 - the value to check.

arg2 - whether to allow subdomains.

Returns:

The resulting IsVirtualHostableS3Bucket function.

ofExpressions

public static IsVirtualHostableS3Bucket ofExpressions(ToExpression arg1,
 boolean arg2)

Creates a IsVirtualHostableS3Bucket function from the given expressions.

Parameters:

arg1 - the value to check.

arg2 - whether to allow subdomains.

Returns:

The resulting IsVirtualHostableS3Bucket function.

accept

public <T> T accept(ExpressionVisitor<T> visitor)

Description copied from class: Expression

Invoke the ExpressionVisitor functions for this expression.

Specified by:

accept in class Expression

Type Parameters:

T - the visitor return type.

Parameters:

visitor - the visitor to be invoked.

Returns:

the return value of the visitor.

isVirtualHostableBucket

public static boolean isVirtualHostableBucket(String hostLabel,
 boolean allowDots)

Checks if the given hostLabel string is a virtual hostable bucket name.

Parameters:

hostLabel - Host label to check.

allowDots - Whether to allow dots in the host label.

Returns:

true if it is compatible.