Skip to content

Latest commit

 

History

History
347 lines (271 loc) · 14.1 KB

Money.md

File metadata and controls

347 lines (271 loc) · 14.1 KB
Raw

Money

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

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 Money.Money1Boxed
sealed interface for validated payloads
record Money.Money1BoxedMap
boxed class to store validated Map payloads
static class Money.Money1
schema class
static class Money.MoneyMapBuilder
builder for Map payloads
static class Money.MoneyMap
output class for Map payloads
sealed interface Money.AmountBoxed
sealed interface for validated payloads
record Money.AmountBoxedString
boxed class to store validated String payloads
static class Money.Amount
schema class
sealed interface Money.AdditionalPropertiesBoxed
sealed interface for validated payloads
record Money.AdditionalPropertiesBoxedVoid
boxed class to store validated null payloads
record Money.AdditionalPropertiesBoxedBoolean
boxed class to store validated boolean payloads
record Money.AdditionalPropertiesBoxedNumber
boxed class to store validated Number payloads
record Money.AdditionalPropertiesBoxedString
boxed class to store validated String payloads
record Money.AdditionalPropertiesBoxedList
boxed class to store validated List payloads
record Money.AdditionalPropertiesBoxedMap
boxed class to store validated Map payloads
static class Money.AdditionalProperties
schema class

Money1Boxed

public sealed interface Money1Boxed
permits
Money1BoxedMap

sealed interface that stores validated payloads using boxed classes

Money1BoxedMap

public record Money1BoxedMap
implements Money1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Money1BoxedMap(MoneyMap data)
Creates an instance, private visibility

Method Summary

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

Money1

public static class Money1
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.Money;

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

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

// Map validation
Money.MoneyMap validatedPayload =
    Money.Money1.validate(
    new Money.MoneyMapBuilder()
        .amount("3.14")

        .currency("eur")

    .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("amount", Amount.class)),
    new PropertyEntry("currency", Currency.Currency1.class)
)
Set required = Set.of(
    "amount",
    "currency"
)
Class<? extends JsonSchema> additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type Method and Description
MoneyMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
Money1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Money1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

MoneyMap00Builder

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

A class that builds the Map input type

Constructor Summary

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

MoneyMap01Builder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
MoneyMap00Builder currency(String value)
MoneyMap00Builder currency(Currency.StringCurrencyEnums value)

MoneyMap10Builder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
MoneyMap00Builder amount(String value)

MoneyMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
MoneyMap01Builder amount(String value)
MoneyMap10Builder currency(String value)
MoneyMap10Builder currency(Currency.StringCurrencyEnums value)

MoneyMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static MoneyMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String amount()
value must be int or float numeric
String currency()

AmountBoxed

public sealed interface AmountBoxed
permits
AmountBoxedString

sealed interface that stores validated payloads using boxed classes

AmountBoxedString

public record AmountBoxedString
implements AmountBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Amount

public static class Amount
extends DecimalJsonSchema.DecimalJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.DecimalJsonSchema.DecimalJsonSchema1
validate
validateAndBox

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedVoid, AdditionalPropertiesBoxedBoolean, AdditionalPropertiesBoxedNumber, AdditionalPropertiesBoxedString, AdditionalPropertiesBoxedList, AdditionalPropertiesBoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesBoxedVoid

public record AdditionalPropertiesBoxedVoid
implements AdditionalPropertiesBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalPropertiesBoxedBoolean

public record AdditionalPropertiesBoxedBoolean
implements AdditionalPropertiesBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalPropertiesBoxedNumber

public record AdditionalPropertiesBoxedNumber
implements AdditionalPropertiesBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalPropertiesBoxedString

public record AdditionalPropertiesBoxedString
implements AdditionalPropertiesBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalPropertiesBoxedList

public record AdditionalPropertiesBoxedList
implements AdditionalPropertiesBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

AdditionalPropertiesBoxedMap

public record AdditionalPropertiesBoxedMap
implements AdditionalPropertiesBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

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

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema.NotAnyTypeJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.NotAnyTypeJsonSchema.NotAnyTypeJsonSchema1
validate
validateAndBox

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