software.amazon.smithy.model.traits

Class EffectiveTraitQuery.Builder

java.lang.Object

software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder

All Implemented Interfaces:

software.amazon.smithy.utils.SmithyBuilder<EffectiveTraitQuery>

Enclosing class:

EffectiveTraitQuery

public static final class EffectiveTraitQuery.Builder
extends java.lang.Object
implements software.amazon.smithy.utils.SmithyBuilder<EffectiveTraitQuery>

Builds a reusable EffectiveTraitQuery.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EffectiveTraitQuery	build()
EffectiveTraitQuery.Builder	inheritFromContainer(boolean inheritFromContainer) When testing member shapes, also checks the container of the member for the presence of a trait.
EffectiveTraitQuery.Builder	model(Model model) Sets the required model to query.
EffectiveTraitQuery.Builder	traitClass(java.lang.Class<? extends Trait> traitClass) Sets the required trait being queried.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.utils.SmithyBuilder

requiredState

Constructor Detail

Builder

public Builder()

Method Detail

build

public EffectiveTraitQuery build()

Specified by:

build in interface software.amazon.smithy.utils.SmithyBuilder<EffectiveTraitQuery>

model

public EffectiveTraitQuery.Builder model(Model model)

Sets the required model to query.

Parameters:

model - Model to query.

Returns:

Returns the query object builder.

traitClass

public EffectiveTraitQuery.Builder traitClass(java.lang.Class<? extends Trait> traitClass)

Sets the required trait being queried.

Parameters:

traitClass - Trait to detect on shapes.

Returns:

Returns the query object builder.

inheritFromContainer

public EffectiveTraitQuery.Builder inheritFromContainer(boolean inheritFromContainer)

When testing member shapes, also checks the container of the member for the presence of a trait.

By default, traits are not inherited from a member's parent container.

Parameters:

inheritFromContainer - Set to true to inherit traits from member containers.

Returns:

Returns the query object builder.