Uses of Enum
dev.metaschema.databind.io.Format

Packages that use Format

Package	Description
dev.metaschema.cli.commands	Provides a collection of abstract and concrete command line interface (CLI) commands that process Metaschema module-based information.
dev.metaschema.databind	Support for parsing Metaschema module-based data using Java class bindings.
dev.metaschema.databind.io	Provides core functionality for reading and writing Metaschema instance data to and from bound Java objects.
dev.metaschema.model.testing	Provides testing utilities for Metaschema modules and constraints.

Uses of Format in dev.metaschema.cli.commands

Methods in dev.metaschema.cli.commands that return Format

Modifier and Type	Method	Description
static Format	MetaschemaCommands.determineSourceFormat(org.apache.commons.cli.CommandLine commandLine, org.apache.commons.cli.Option option, IBoundLoader loader, URI resource)	Detect the source format for content identified using the provided option.
static Format	MetaschemaCommands.getFormat(org.apache.commons.cli.CommandLine commandLine, org.apache.commons.cli.Option option)	Parse the command line options to get the selected format.

Methods in dev.metaschema.cli.commands with parameters of type Format

Modifier and Type	Method	Description
protected abstract void	AbstractConvertSubcommand.AbstractConversionCommandExecutor.handleConversion(URI source, Format toFormat, Writer writer, IBoundLoader loader)	Called to perform a content conversion.

Uses of Format in dev.metaschema.databind

Methods in dev.metaschema.databind with parameters of type Format

Modifier and Type	Method	Description
<CLASS extends IBoundObject> IDeserializer<CLASS>	DefaultBindingContext.newDeserializer(Format format, Class<CLASS> clazz)	Gets a data IDeserializer which can be used to read Java instance data for the provided class from the requested format.
<CLASS extends IBoundObject> IDeserializer<CLASS>	IBindingContext.newDeserializer(Format format, Class<CLASS> clazz)	Gets a data IDeserializer which can be used to read Java instance data for the provided class from the requested format.
<CLASS extends IBoundObject> ISerializer<CLASS>	DefaultBindingContext.newSerializer(Format format, Class<CLASS> clazz)	Gets a data ISerializer which can be used to write Java instance data for the provided class in the requested format.
<CLASS extends IBoundObject> ISerializer<CLASS>	IBindingContext.newSerializer(Format format, Class<CLASS> clazz)	Gets a data ISerializer which can be used to write Java instance data for the provided class in the requested format.
default IValidationResult	IBindingContext.validate(URI target, Format asFormat, IBindingContext.ISchemaValidationProvider schemaProvider, IConfiguration<ValidationFeature<?>> config)	Load and perform schema and constraint validation on the target.
default IValidationResult	IBindingContext.ISchemaValidationProvider.validateWithSchema(URI target, Format asFormat, IBindingContext bindingContext)	Validate the target resource.

Uses of Format in dev.metaschema.databind.io

Methods in dev.metaschema.databind.io that return Format

Modifier and Type	Method	Description
Format	DefaultBoundLoader.detectFormat(URI uri)
default Format	IBoundLoader.detectFormat(File file)	Determine the format of the provided resource.
Format	IBoundLoader.detectFormat(URI uri)	Determine the format of the resource identified by the provided uri.
default Format	IBoundLoader.detectFormat(URL url)	Determine the format of the provided resource.
default Format	IBoundLoader.detectFormat(Path path)	Determine the format of the provided resource.
Format	FormatDetector.Result.getFormat()	Get the detected format.
Format	ValidationContext.getFormat()	Get the format being parsed.
static Format	Format.valueOf(String name)	Returns the enum constant of this type with the specified name.
static Format[]	Format.values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods in dev.metaschema.databind.io with parameters of type Format

Modifier and Type	Method	Description
default <CLASS extends IBoundObject> void	IBoundLoader.convert(URI source, OutputStream os, Format toFormat, Class<CLASS> rootClass)	Auto convert the provided source to the provided toFormat.
default <CLASS extends IBoundObject> void	IBoundLoader.convert(URI source, Writer writer, Format toFormat, Class<CLASS> rootClass)	Auto convert the provided source to the provided toFormat.
default <CLASS extends IBoundObject> void	IBoundLoader.convert(URI source, Path destination, Format toFormat, Class<CLASS> rootClass)	Auto convert the provided source to the provided toFormat.
default <CLASS extends IBoundObject> void	IBoundLoader.convert(Path source, OutputStream os, Format toFormat, Class<CLASS> rootClass)	Auto convert the provided source to the provided toFormat.
default <CLASS extends IBoundObject> void	IBoundLoader.convert(Path source, Path destination, Format toFormat, Class<CLASS> rootClass)	Auto convert the provided source to the provided toFormat.
@Owning ModelDetector.Result	ModelDetector.detect(@Owning InputStream inputStream, URI resource, Format format)	Analyzes the data from the provided inputStream to determine it's model.
@Owning ModelDetector.Result	DefaultBoundLoader.detectModel(InputStream is, URI resource, Format format)
ModelDetector.Result	IBoundLoader.detectModel(InputStream is, URI resource, Format format)	Determine the model of the provided resource.
<CLASS extends IBoundObject> CLASS	DefaultBoundLoader.load(Class<CLASS> clazz, Format format, InputStream is, URI documentUri)
<CLASS extends IBoundObject> CLASS	IBoundLoader.load(Class<CLASS> clazz, Format format, InputStream is, URI resource)	Load data from the specified resource into a bound object with the type of the specified Java class.
IDocumentNodeItem	DefaultBoundLoader.loadAsNodeItem(Format format, InputStream is, URI resource)
IDocumentNodeItem	DefaultBoundLoader.loadAsNodeItem(Format format, URI uri)
IDocumentNodeItem	IBoundLoader.loadAsNodeItem(Format format, InputStream is, URI resource)	Load data expressed using the provided format and return that data as a Metapath node item.
IDocumentNodeItem	IBoundLoader.loadAsNodeItem(Format format, URI uri)	Load data expressed using the provided format and return that data as a Metapath node item.
default IDocumentNodeItem	IBoundLoader.loadAsNodeItem(Format format, Path path)	Load data expressed using the provided format and return that data as a Metapath node item.
static ValidationContext	ValidationContext.of(URI source, IResourceLocation location, String path, Format format)	Create a new validation context.
static ValidationContext	ValidationContext.ofUnknownLocation(URI source, String path, Format format)	Create a validation context with unknown location.
static IPathFormatter	Format.resolvePathFormatter(PathFormatSelection selection, Format format)	Resolve the path formatter based on the selection and document format.

Uses of Format in dev.metaschema.model.testing

Methods in dev.metaschema.model.testing that return Format

Modifier and Type	Method	Description
protected abstract Format	AbstractTestSuite.getRequiredContentFormat()	Get the content format used by the test suite.