Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Capitalization.md

Latest commit

 

History

History
382 lines (297 loc) · 16.7 KB

Capitalization.md

File metadata and controls

382 lines (297 loc) · 16.7 KB

Capitalization

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

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 Capitalization.Capitalization1Boxed
sealed interface for validated payloads
record Capitalization.Capitalization1BoxedMap
boxed class to store validated Map payloads
static class Capitalization.Capitalization1
schema class
static class Capitalization.CapitalizationMapBuilder
builder for Map payloads
static class Capitalization.CapitalizationMap
output class for Map payloads
sealed interface Capitalization.ATTNAMEBoxed
sealed interface for validated payloads
record Capitalization.ATTNAMEBoxedString
boxed class to store validated String payloads
static class Capitalization.ATTNAME
schema class
sealed interface Capitalization.SCAETHFlowPointsBoxed
sealed interface for validated payloads
record Capitalization.SCAETHFlowPointsBoxedString
boxed class to store validated String payloads
static class Capitalization.SCAETHFlowPoints
schema class
sealed interface Capitalization.CapitalSnakeBoxed
sealed interface for validated payloads
record Capitalization.CapitalSnakeBoxedString
boxed class to store validated String payloads
static class Capitalization.CapitalSnake
schema class
sealed interface Capitalization.SmallSnakeBoxed
sealed interface for validated payloads
record Capitalization.SmallSnakeBoxedString
boxed class to store validated String payloads
static class Capitalization.SmallSnake
schema class
sealed interface Capitalization.CapitalCamelBoxed
sealed interface for validated payloads
record Capitalization.CapitalCamelBoxedString
boxed class to store validated String payloads
static class Capitalization.CapitalCamel
schema class
sealed interface Capitalization.SmallCamelBoxed
sealed interface for validated payloads
record Capitalization.SmallCamelBoxedString
boxed class to store validated String payloads
static class Capitalization.SmallCamel
schema class

Capitalization1Boxed

public sealed interface Capitalization1Boxed
permits
Capitalization1BoxedMap

sealed interface that stores validated payloads using boxed classes

Capitalization1BoxedMap

public record Capitalization1BoxedMap
implements Capitalization1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Capitalization1BoxedMap(CapitalizationMap data)
Creates an instance, private visibility

Method Summary

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

Capitalization1

public static class Capitalization1
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.Capitalization;

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

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

// Map validation
Capitalization.CapitalizationMap validatedPayload =
    Capitalization.Capitalization1.validate(
    new Capitalization.CapitalizationMapBuilder()
        .smallCamel("a")

        .CapitalCamel("a")

        .small_Snake("a")

        .Capital_Snake("a")

        .SCA_ETH_Flow_Points("a")

        .ATT_NAME("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("smallCamel", SmallCamel.class)),
    new PropertyEntry("CapitalCamel", CapitalCamel.class)),
    new PropertyEntry("small_Snake", SmallSnake.class)),
    new PropertyEntry("Capital_Snake", CapitalSnake.class)),
    new PropertyEntry("SCA_ETH_Flow_Points", SCAETHFlowPoints.class)),
    new PropertyEntry("ATT_NAME", ATTNAME.class))
)

Method Summary

Modifier and Type Method and Description
CapitalizationMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
Capitalization1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Capitalization1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

CapitalizationMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

CapitalizationMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static CapitalizationMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String smallCamel()
[optional]
String CapitalCamel()
[optional]
String small_Snake()
[optional]
String Capital_Snake()
[optional]
String SCA_ETH_Flow_Points()
[optional]
String ATT_NAME()
[optional]
@Nullable Object getAdditionalProperty(String name)
provides type safety for additional properties

ATTNAMEBoxed

public sealed interface ATTNAMEBoxed
permits
ATTNAMEBoxedString

sealed interface that stores validated payloads using boxed classes

ATTNAMEBoxedString

public record ATTNAMEBoxedString
implements ATTNAMEBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ATTNAME

public static class ATTNAME
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

Description

Name of the pet

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

SCAETHFlowPointsBoxed

public sealed interface SCAETHFlowPointsBoxed
permits
SCAETHFlowPointsBoxedString

sealed interface that stores validated payloads using boxed classes

SCAETHFlowPointsBoxedString

public record SCAETHFlowPointsBoxedString
implements SCAETHFlowPointsBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

SCAETHFlowPoints

public static class SCAETHFlowPoints
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

CapitalSnakeBoxed

public sealed interface CapitalSnakeBoxed
permits
CapitalSnakeBoxedString

sealed interface that stores validated payloads using boxed classes

CapitalSnakeBoxedString

public record CapitalSnakeBoxedString
implements CapitalSnakeBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

CapitalSnake

public static class CapitalSnake
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

SmallSnakeBoxed

public sealed interface SmallSnakeBoxed
permits
SmallSnakeBoxedString

sealed interface that stores validated payloads using boxed classes

SmallSnakeBoxedString

public record SmallSnakeBoxedString
implements SmallSnakeBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

SmallSnake

public static class SmallSnake
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

CapitalCamelBoxed

public sealed interface CapitalCamelBoxed
permits
CapitalCamelBoxedString

sealed interface that stores validated payloads using boxed classes

CapitalCamelBoxedString

public record CapitalCamelBoxedString
implements CapitalCamelBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

CapitalCamel

public static class CapitalCamel
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

SmallCamelBoxed

public sealed interface SmallCamelBoxed
permits
SmallCamelBoxedString

sealed interface that stores validated payloads using boxed classes

SmallCamelBoxedString

public record SmallCamelBoxedString
implements SmallCamelBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

SmallCamel

public static class SmallCamel
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]