Skip to content

Latest commit

 

History

History
438 lines (354 loc) · 18.3 KB

ItemsContains.md

File metadata and controls

438 lines (354 loc) · 18.3 KB
Raw

ItemsContains

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

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 list payloads, extends FrozenList
  • classes to build inputs for list payloads

Nested Class Summary

Modifier and Type Class and Description
sealed interface ItemsContains.ItemsContains1Boxed
sealed interface for validated payloads
record ItemsContains.ItemsContains1BoxedList
boxed class to store validated List payloads
static class ItemsContains.ItemsContains1
schema class
static class ItemsContains.ItemsContainsListBuilder
builder for List payloads
static class ItemsContains.ItemsContainsList
output class for List payloads
sealed interface ItemsContains.ItemsBoxed
sealed interface for validated payloads
record ItemsContains.ItemsBoxedVoid
boxed class to store validated null payloads
record ItemsContains.ItemsBoxedBoolean
boxed class to store validated boolean payloads
record ItemsContains.ItemsBoxedNumber
boxed class to store validated Number payloads
record ItemsContains.ItemsBoxedString
boxed class to store validated String payloads
record ItemsContains.ItemsBoxedList
boxed class to store validated List payloads
record ItemsContains.ItemsBoxedMap
boxed class to store validated Map payloads
static class ItemsContains.Items
schema class
sealed interface ItemsContains.ContainsBoxed
sealed interface for validated payloads
record ItemsContains.ContainsBoxedVoid
boxed class to store validated null payloads
record ItemsContains.ContainsBoxedBoolean
boxed class to store validated boolean payloads
record ItemsContains.ContainsBoxedNumber
boxed class to store validated Number payloads
record ItemsContains.ContainsBoxedString
boxed class to store validated String payloads
record ItemsContains.ContainsBoxedList
boxed class to store validated List payloads
record ItemsContains.ContainsBoxedMap
boxed class to store validated Map payloads
static class ItemsContains.Contains
schema class

ItemsContains1Boxed

public sealed interface ItemsContains1Boxed
permits
ItemsContains1BoxedList

sealed interface that stores validated payloads using boxed classes

ItemsContains1BoxedList

public record ItemsContains1BoxedList
implements ItemsContains1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsContains1BoxedList(ItemsContainsList data)
Creates an instance, private visibility

Method Summary

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

ItemsContains1

public static class ItemsContains1
extends JsonSchema

A schema class that validates payloads

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.ItemsContains;

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

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

// List validation
ItemsContains.ItemsContainsList validatedPayload =
    ItemsContains.ItemsContains1.validate(
    new ItemsContains.ItemsContainsListBuilder()
    .build(),
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(List.class)
Class<? extends JsonSchema> items = Items.class
Class<? extends JsonSchema> contains = Contains.class

Method Summary

Modifier and Type Method and Description
ItemsContainsList validate(List<?> arg, SchemaConfiguration configuration)
ItemsContains1BoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
ItemsContains1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

ItemsContainsListBuilder

public class ItemsContainsListBuilder
builder for List<@Nullable Object>

A class that builds the List input type

Constructor Summary

Constructor and Description
ItemsContainsListBuilder()
Creates an empty list
ItemsContainsListBuilder(List<@Nullable Object> items)
Stores the items in a list

Method Summary

Modifier and Type Method and Description
ItemsContainsListBuilder add(Void item)
ItemsContainsListBuilder add(boolean item)
ItemsContainsListBuilder add(String item)
ItemsContainsListBuilder add(int item)
ItemsContainsListBuilder add(float item)
ItemsContainsListBuilder add(long item)
ItemsContainsListBuilder add(double item)
ItemsContainsListBuilder add(List<?> item)
ItemsContainsListBuilder add(Map<String, ?> item)
List<@Nullable Object> build()
Returns list input that should be used with Schema.validate

ItemsContainsList

public class ItemsContainsList
extends FrozenList<@Nullable Object>

A class to store validated List payloads

Method Summary

Modifier and Type Method and Description
static ItemsContainsList of(List<? extends @Nullable Object> arg, SchemaConfiguration configuration)

ItemsBoxed

public sealed interface ItemsBoxed
permits
ItemsBoxedVoid, ItemsBoxedBoolean, ItemsBoxedNumber, ItemsBoxedString, ItemsBoxedList, ItemsBoxedMap

sealed interface that stores validated payloads using boxed classes

ItemsBoxedVoid

public record ItemsBoxedVoid
implements ItemsBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsBoxedVoid(Void data)
Creates an instance, private visibility

Method Summary

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

ItemsBoxedBoolean

public record ItemsBoxedBoolean
implements ItemsBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsBoxedBoolean(boolean data)
Creates an instance, private visibility

Method Summary

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

ItemsBoxedNumber

public record ItemsBoxedNumber
implements ItemsBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsBoxedNumber(Number data)
Creates an instance, private visibility

Method Summary

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

ItemsBoxedString

public record ItemsBoxedString
implements ItemsBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ItemsBoxedList

public record ItemsBoxedList
implements ItemsBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsBoxedList(FrozenList<@Nullable Object> data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
FrozenList<@Nullable Object> data()
validated payload
@Nullable Object getData()
validated payload

ItemsBoxedMap

public record ItemsBoxedMap
implements ItemsBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsBoxedMap(FrozenMap<@Nullable Object> data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
FrozenMap<@Nullable Object> data()
validated payload
@Nullable Object getData()
validated payload

Items

public static class Items
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
BigDecimal multipleOf = new BigDecimal("2")

Method Summary

Modifier and Type Method and Description
String validate(String arg, SchemaConfiguration configuration)
Void validate(Void arg, SchemaConfiguration configuration)
int validate(int arg, SchemaConfiguration configuration)
long validate(long arg, SchemaConfiguration configuration)
float validate(float arg, SchemaConfiguration configuration)
double validate(double arg, SchemaConfiguration configuration)
Number validate(Number arg, SchemaConfiguration configuration)
boolean validate(boolean arg, SchemaConfiguration configuration)
FrozenMap<@Nullable Object> validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
ItemsBoxedString validateAndBox(String arg, SchemaConfiguration configuration)
ItemsBoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
ItemsBoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
ItemsBoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
ItemsBoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ItemsBoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
ItemsBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

ContainsBoxed

public sealed interface ContainsBoxed
permits
ContainsBoxedVoid, ContainsBoxedBoolean, ContainsBoxedNumber, ContainsBoxedString, ContainsBoxedList, ContainsBoxedMap

sealed interface that stores validated payloads using boxed classes

ContainsBoxedVoid

public record ContainsBoxedVoid
implements ContainsBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ContainsBoxedVoid(Void data)
Creates an instance, private visibility

Method Summary

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

ContainsBoxedBoolean

public record ContainsBoxedBoolean
implements ContainsBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ContainsBoxedBoolean(boolean data)
Creates an instance, private visibility

Method Summary

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

ContainsBoxedNumber

public record ContainsBoxedNumber
implements ContainsBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ContainsBoxedNumber(Number data)
Creates an instance, private visibility

Method Summary

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

ContainsBoxedString

public record ContainsBoxedString
implements ContainsBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ContainsBoxedList

public record ContainsBoxedList
implements ContainsBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ContainsBoxedList(FrozenList<@Nullable Object> data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
FrozenList<@Nullable Object> data()
validated payload
@Nullable Object getData()
validated payload

ContainsBoxedMap

public record ContainsBoxedMap
implements ContainsBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ContainsBoxedMap(FrozenMap<@Nullable Object> data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
FrozenMap<@Nullable Object> data()
validated payload
@Nullable Object getData()
validated payload

Contains

public static class Contains
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
BigDecimal multipleOf = new BigDecimal("3")

Method Summary

Modifier and Type Method and Description
String validate(String arg, SchemaConfiguration configuration)
Void validate(Void arg, SchemaConfiguration configuration)
int validate(int arg, SchemaConfiguration configuration)
long validate(long arg, SchemaConfiguration configuration)
float validate(float arg, SchemaConfiguration configuration)
double validate(double arg, SchemaConfiguration configuration)
Number validate(Number arg, SchemaConfiguration configuration)
boolean validate(boolean arg, SchemaConfiguration configuration)
FrozenMap<@Nullable Object> validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
ContainsBoxedString validateAndBox(String arg, SchemaConfiguration configuration)
ContainsBoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
ContainsBoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
ContainsBoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
ContainsBoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ContainsBoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
ContainsBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

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