Skip to content

Latest commit

 

History

History
266 lines (214 loc) · 11.6 KB

NotMultipleTypes.md

File metadata and controls

266 lines (214 loc) · 11.6 KB
Raw

NotMultipleTypes

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

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

Nested Class Summary

Modifier and Type Class and Description
sealed interface NotMultipleTypes.NotMultipleTypes1Boxed
sealed interface for validated payloads
record NotMultipleTypes.NotMultipleTypes1BoxedVoid
boxed class to store validated null payloads
record NotMultipleTypes.NotMultipleTypes1BoxedBoolean
boxed class to store validated boolean payloads
record NotMultipleTypes.NotMultipleTypes1BoxedNumber
boxed class to store validated Number payloads
record NotMultipleTypes.NotMultipleTypes1BoxedString
boxed class to store validated String payloads
record NotMultipleTypes.NotMultipleTypes1BoxedList
boxed class to store validated List payloads
record NotMultipleTypes.NotMultipleTypes1BoxedMap
boxed class to store validated Map payloads
static class NotMultipleTypes.NotMultipleTypes1
schema class
sealed interface NotMultipleTypes.NotBoxed
sealed interface for validated payloads
record NotMultipleTypes.NotBoxedNumber
boxed class to store validated Number payloads
record NotMultipleTypes.NotBoxedBoolean
boxed class to store validated boolean payloads
static class NotMultipleTypes.Not
schema class

NotMultipleTypes1Boxed

public sealed interface NotMultipleTypes1Boxed
permits
NotMultipleTypes1BoxedVoid, NotMultipleTypes1BoxedBoolean, NotMultipleTypes1BoxedNumber, NotMultipleTypes1BoxedString, NotMultipleTypes1BoxedList, NotMultipleTypes1BoxedMap

sealed interface that stores validated payloads using boxed classes

NotMultipleTypes1BoxedVoid

public record NotMultipleTypes1BoxedVoid
implements NotMultipleTypes1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

NotMultipleTypes1BoxedBoolean

public record NotMultipleTypes1BoxedBoolean
implements NotMultipleTypes1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

NotMultipleTypes1BoxedNumber

public record NotMultipleTypes1BoxedNumber
implements NotMultipleTypes1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

NotMultipleTypes1BoxedString

public record NotMultipleTypes1BoxedString
implements NotMultipleTypes1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

NotMultipleTypes1BoxedList

public record NotMultipleTypes1BoxedList
implements NotMultipleTypes1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
NotMultipleTypes1BoxedList(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

NotMultipleTypes1BoxedMap

public record NotMultipleTypes1BoxedMap
implements NotMultipleTypes1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
NotMultipleTypes1BoxedMap(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

NotMultipleTypes1

public static class NotMultipleTypes1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
Class<? extends JsonSchema> not = Not.class

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)
NotMultipleTypes1BoxedString validateAndBox(String arg, SchemaConfiguration configuration)
NotMultipleTypes1BoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
NotMultipleTypes1BoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
NotMultipleTypes1BoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
NotMultipleTypes1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
NotMultipleTypes1BoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
NotMultipleTypes1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

NotBoxed

public sealed interface NotBoxed
permits
NotBoxedNumber, NotBoxedBoolean

sealed interface that stores validated payloads using boxed classes

NotBoxedNumber

public record NotBoxedNumber
implements NotBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

NotBoxedBoolean

public record NotBoxedBoolean
implements NotBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Not

public static class Not
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.NotMultipleTypes;

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

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

// int validation
int validatedPayload = NotMultipleTypes.Not.validate(
    1L,
    configuration
);

// boolean validation
boolean validatedPayload = NotMultipleTypes.Not.validate(
    true,
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(
    Integer.class,
    Long.class,
    Float.class,
    Double.class,
    Boolean.class
)
String type = "int";

Method Summary

Modifier and Type Method and Description
long validate(long arg, SchemaConfiguration configuration)
NotBoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
boolean validate(boolean arg, SchemaConfiguration configuration)
NotBoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
NotBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

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