AbstractStepMessage.md

AbstractStepMessage

org.openapijsonschematools.client.components.schemas.AbstractStepMessage.java public class AbstractStepMessage

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• sealed interfaces which store validated payloads, java version of a sum type
• boxed classes which store validated payloads, sealed permits class implementations
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	AbstractStepMessage.AbstractStepMessage1Boxed sealed interface for validated payloads
record	AbstractStepMessage.AbstractStepMessage1BoxedMap boxed class to store validated Map payloads
static class	AbstractStepMessage.AbstractStepMessage1 schema class
static class	AbstractStepMessage.AbstractStepMessageMapBuilder builder for Map payloads
static class	AbstractStepMessage.AbstractStepMessageMap output class for Map payloads
sealed interface	AbstractStepMessage.DiscriminatorBoxed sealed interface for validated payloads
record	AbstractStepMessage.DiscriminatorBoxedString boxed class to store validated String payloads
static class	AbstractStepMessage.Discriminator schema class

AbstractStepMessage1Boxed

public sealed interface AbstractStepMessage1Boxed
permits
AbstractStepMessage1BoxedMap

sealed interface that stores validated payloads using boxed classes

AbstractStepMessage1BoxedMap

public record AbstractStepMessage1BoxedMap
implements AbstractStepMessage1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AbstractStepMessage1BoxedMap(AbstractStepMessageMap data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap	data() validated payload
@Nullable Object	getData() validated payload

AbstractStepMessage1

public static class AbstractStepMessage1
extends JsonSchema

A schema class that validates payloads

Description

Abstract Step

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.AbstractStepMessage;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
AbstractStepMessage.AbstractStepMessageMap validatedPayload =
    AbstractStepMessage.AbstractStepMessage1.validate(
    new AbstractStepMessage.AbstractStepMessageMapBuilder()
        .discriminator("a")

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries(     new PropertyEntry("discriminator", Discriminator.class)) )
Set	required = Set.of(     "description",     "discriminator",     "sequenceNumber" )
List<Class<? extends JsonSchema>>	anyOf = List.of(     AbstractStepMessage1.class )

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
AbstractStepMessage1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AbstractStepMessage1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

AbstractStepMessageMap000Builder

public class AbstractStepMessageMap000Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AbstractStepMessageMap000Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate
AbstractStepMessageMap000Builder	additionalProperty(String key, Void value)
AbstractStepMessageMap000Builder	additionalProperty(String key, boolean value)
AbstractStepMessageMap000Builder	additionalProperty(String key, String value)
AbstractStepMessageMap000Builder	additionalProperty(String key, int value)
AbstractStepMessageMap000Builder	additionalProperty(String key, float value)
AbstractStepMessageMap000Builder	additionalProperty(String key, long value)
AbstractStepMessageMap000Builder	additionalProperty(String key, double value)
AbstractStepMessageMap000Builder	additionalProperty(String key, List<?> value)
AbstractStepMessageMap000Builder	additionalProperty(String key, Map<String, ?> value)

AbstractStepMessageMap001Builder

public class AbstractStepMessageMap001Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AbstractStepMessageMap001Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap000Builder	sequenceNumber(Void value)
AbstractStepMessageMap000Builder	sequenceNumber(boolean value)
AbstractStepMessageMap000Builder	sequenceNumber(String value)
AbstractStepMessageMap000Builder	sequenceNumber(int value)
AbstractStepMessageMap000Builder	sequenceNumber(float value)
AbstractStepMessageMap000Builder	sequenceNumber(long value)
AbstractStepMessageMap000Builder	sequenceNumber(double value)
AbstractStepMessageMap000Builder	sequenceNumber(List<?> value)
AbstractStepMessageMap000Builder	sequenceNumber(Map<String, ?> value)

AbstractStepMessageMap010Builder

public class AbstractStepMessageMap010Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AbstractStepMessageMap010Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap000Builder	discriminator(String value)

AbstractStepMessageMap011Builder

public class AbstractStepMessageMap011Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AbstractStepMessageMap011Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap001Builder	discriminator(String value)
AbstractStepMessageMap010Builder	sequenceNumber(Void value)
AbstractStepMessageMap010Builder	sequenceNumber(boolean value)
AbstractStepMessageMap010Builder	sequenceNumber(String value)
AbstractStepMessageMap010Builder	sequenceNumber(int value)
AbstractStepMessageMap010Builder	sequenceNumber(float value)
AbstractStepMessageMap010Builder	sequenceNumber(long value)
AbstractStepMessageMap010Builder	sequenceNumber(double value)
AbstractStepMessageMap010Builder	sequenceNumber(List<?> value)
AbstractStepMessageMap010Builder	sequenceNumber(Map<String, ?> value)

AbstractStepMessageMap100Builder

public class AbstractStepMessageMap100Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AbstractStepMessageMap100Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap000Builder	description(Void value)
AbstractStepMessageMap000Builder	description(boolean value)
AbstractStepMessageMap000Builder	description(String value)
AbstractStepMessageMap000Builder	description(int value)
AbstractStepMessageMap000Builder	description(float value)
AbstractStepMessageMap000Builder	description(long value)
AbstractStepMessageMap000Builder	description(double value)
AbstractStepMessageMap000Builder	description(List<?> value)
AbstractStepMessageMap000Builder	description(Map<String, ?> value)

AbstractStepMessageMap101Builder

public class AbstractStepMessageMap101Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AbstractStepMessageMap101Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap001Builder	description(Void value)
AbstractStepMessageMap001Builder	description(boolean value)
AbstractStepMessageMap001Builder	description(String value)
AbstractStepMessageMap001Builder	description(int value)
AbstractStepMessageMap001Builder	description(float value)
AbstractStepMessageMap001Builder	description(long value)
AbstractStepMessageMap001Builder	description(double value)
AbstractStepMessageMap001Builder	description(List<?> value)
AbstractStepMessageMap001Builder	description(Map<String, ?> value)
AbstractStepMessageMap100Builder	sequenceNumber(Void value)
AbstractStepMessageMap100Builder	sequenceNumber(boolean value)
AbstractStepMessageMap100Builder	sequenceNumber(String value)
AbstractStepMessageMap100Builder	sequenceNumber(int value)
AbstractStepMessageMap100Builder	sequenceNumber(float value)
AbstractStepMessageMap100Builder	sequenceNumber(long value)
AbstractStepMessageMap100Builder	sequenceNumber(double value)
AbstractStepMessageMap100Builder	sequenceNumber(List<?> value)
AbstractStepMessageMap100Builder	sequenceNumber(Map<String, ?> value)

AbstractStepMessageMap110Builder

public class AbstractStepMessageMap110Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AbstractStepMessageMap110Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap010Builder	description(Void value)
AbstractStepMessageMap010Builder	description(boolean value)
AbstractStepMessageMap010Builder	description(String value)
AbstractStepMessageMap010Builder	description(int value)
AbstractStepMessageMap010Builder	description(float value)
AbstractStepMessageMap010Builder	description(long value)
AbstractStepMessageMap010Builder	description(double value)
AbstractStepMessageMap010Builder	description(List<?> value)
AbstractStepMessageMap010Builder	description(Map<String, ?> value)
AbstractStepMessageMap100Builder	discriminator(String value)

AbstractStepMessageMapBuilder

public class AbstractStepMessageMapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AbstractStepMessageMapBuilder() Creates a builder that contains an empty map

Method Summary

Modifier and Type	Method and Description
AbstractStepMessageMap011Builder	description(Void value)
AbstractStepMessageMap011Builder	description(boolean value)
AbstractStepMessageMap011Builder	description(String value)
AbstractStepMessageMap011Builder	description(int value)
AbstractStepMessageMap011Builder	description(float value)
AbstractStepMessageMap011Builder	description(long value)
AbstractStepMessageMap011Builder	description(double value)
AbstractStepMessageMap011Builder	description(List<?> value)
AbstractStepMessageMap011Builder	description(Map<String, ?> value)
AbstractStepMessageMap101Builder	discriminator(String value)
AbstractStepMessageMap110Builder	sequenceNumber(Void value)
AbstractStepMessageMap110Builder	sequenceNumber(boolean value)
AbstractStepMessageMap110Builder	sequenceNumber(String value)
AbstractStepMessageMap110Builder	sequenceNumber(int value)
AbstractStepMessageMap110Builder	sequenceNumber(float value)
AbstractStepMessageMap110Builder	sequenceNumber(long value)
AbstractStepMessageMap110Builder	sequenceNumber(double value)
AbstractStepMessageMap110Builder	sequenceNumber(List<?> value)
AbstractStepMessageMap110Builder	sequenceNumber(Map<String, ?> value)

AbstractStepMessageMap

public static class AbstractStepMessageMap
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static AbstractStepMessageMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
@Nullable Object	description()
String	discriminator()
@Nullable Object	sequenceNumber()
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

DiscriminatorBoxed

public sealed interface DiscriminatorBoxed
permits
DiscriminatorBoxedString

sealed interface that stores validated payloads using boxed classes

DiscriminatorBoxedString

public record DiscriminatorBoxedString
implements DiscriminatorBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
DiscriminatorBoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

Discriminator

public static class Discriminator
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema.StringJsonSchema1
validate
validateAndBox

[Back to top] [Back to Component Schemas] [Back to README]