Package software.amazon.smithy.model.knowledge

Class NullableIndex

java.lang.Object

software.amazon.smithy.model.knowledge.NullableIndex

All Implemented Interfaces:

KnowledgeIndex

Direct Known Subclasses:

BoxIndex

public class NullableIndex
extends java.lang.Object
implements KnowledgeIndex

An index that checks if a member is nullable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NullableIndex.CheckMode	Defines the type of model consumer to assume when determining if a member should be considered nullable or always present.

Constructor Summary

Constructors

Constructor	Description
NullableIndex(Model model)

Method Summary

Modifier and Type	Method	Description
boolean	isMemberNullable(MemberShape member)	Checks if a member is nullable using NullableIndex.CheckMode.CLIENT.
boolean	isMemberNullable(MemberShape member, NullableIndex.CheckMode checkMode)	Checks if a member is nullable using v2 nullability rules.
boolean	isNullable(ToShapeId shapeId)	Deprecated.
static NullableIndex	of(Model model)

Methods inherited from class java.lang.Object

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

Constructor Detail

NullableIndex

public NullableIndex(Model model)

Method Detail

of

public static NullableIndex of(Model model)

isMemberNullable

public boolean isMemberNullable(MemberShape member)

Checks if a member is nullable using NullableIndex.CheckMode.CLIENT.

Parameters:

member - Member to check.

Returns:

Returns true if the member is optional in non-authoritative consumers of the model like clients.

See Also:

isMemberNullable(MemberShape, CheckMode)

isMemberNullable

public boolean isMemberNullable(MemberShape member,
                                NullableIndex.CheckMode checkMode)

Checks if a member is nullable using v2 nullability rules.

A checkMode parameter is required to declare what kind of model consumer is checking if the member is optional. The authoritative consumers like servers do not need to honor the InputTrait or ClientOptionalTrait, while non-authoritative consumers like clients must honor these traits.

Parameters:

member - Member to check.

checkMode - The mode used when checking if the member is considered nullable.

Returns:

Returns true if the member is optional.

isNullable

@Deprecated
public final boolean isNullable(ToShapeId shapeId)

Deprecated.

Checks if the given shape is optional using Smithy IDL 1.0 semantics.

This means that the default trait is ignored, the required trait is ignored, and only the box trait and sparse traits are used.

Use isMemberNullable(MemberShape) to check using Smithy IDL 2.0 semantics that take required, default, and other traits into account. That method also accurately returns the nullability of 1.0 members as long as the model it's checking was sent through a ModelAssembler.

Parameters:

shapeId - Shape or shape ID to check.

Returns:

Returns true if the shape is nullable.