File.md

File

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	File.File1 schema class
static class	File.FileMapBuilder builder for Map payloads
static class	File.FileMap output class for Map payloads
static class	File.SourceURI schema class

File1

public static class File1
extends JsonSchema

A schema class that validates payloads

Description

Must be named `File` for test.

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
File.FileMap validatedPayload =
    File.File1.validate(
    new File.FileMapBuilder()
        .sourceURI("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("sourceURI", SourceURI.class)) )

Method Summary

Modifier and Type	Method and Description
FileMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

FileMapBuilder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
FileMapBuilder() 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
FileMapBuilder	sourceURI(String value)
FileMapBuilder	additionalProperty(String key, Void value)
FileMapBuilder	additionalProperty(String key, boolean value)
FileMapBuilder	additionalProperty(String key, String value)
FileMapBuilder	additionalProperty(String key, int value)
FileMapBuilder	additionalProperty(String key, float value)
FileMapBuilder	additionalProperty(String key, long value)
FileMapBuilder	additionalProperty(String key, double value)
FileMapBuilder	additionalProperty(String key, List<?> value)
FileMapBuilder	additionalProperty(String key, Map<String, ?> value)

FileMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static FileMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String	sourceURI() [optional]
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

SourceURI

public static class SourceURI
extends StringJsonSchema

A schema class that validates payloads

Description

Test capitalization

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

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