Module dev.metaschema.databind
Package dev.metaschema.databind.io

Interface IDeserializer<CLASS extends dev.metaschema.core.model.IBoundObject>

Type Parameters:
CLASS - the Java type into which data can be read
All Superinterfaces:
dev.metaschema.core.configuration.IConfiguration<DeserializationFeature<?>>, dev.metaschema.core.configuration.IMutableConfiguration<DeserializationFeature<?>>
All Known Implementing Classes:
AbstractDeserializer, DefaultJsonDeserializer, DefaultXmlDeserializer, DefaultYamlDeserializer
public interface IDeserializer<CLASS extends dev.metaschema.core.model.IBoundObject> extends dev.metaschema.core.configuration.IMutableConfiguration<DeserializationFeature<?>>
Implementations of this interface are able to read structured data into a bound object instance of the parameterized type.

  • Method Details

    • enableFeature

      IDeserializer<CLASS> enableFeature(DeserializationFeature<?> feature)
      Specified by:
      enableFeature in interface dev.metaschema.core.configuration.IMutableConfiguration<CLASS extends dev.metaschema.core.model.IBoundObject>

    • disableFeature

      IDeserializer<CLASS> disableFeature(DeserializationFeature<?> feature)
      Specified by:
      disableFeature in interface dev.metaschema.core.configuration.IMutableConfiguration<CLASS extends dev.metaschema.core.model.IBoundObject>

    • applyConfiguration

      IDeserializer<CLASS> applyConfiguration(dev.metaschema.core.configuration.IConfiguration<DeserializationFeature<?>> other)
      Specified by:
      applyConfiguration in interface dev.metaschema.core.configuration.IMutableConfiguration<CLASS extends dev.metaschema.core.model.IBoundObject>

    • set

      IDeserializer<CLASS> set(DeserializationFeature<?> feature, Object value)
      Specified by:
      set in interface dev.metaschema.core.configuration.IMutableConfiguration<CLASS extends dev.metaschema.core.model.IBoundObject>

    • isValidating

      default boolean isValidating()
      Determine if the serializer is performing validation.
      Returns:
      true if the serializer is performing content validation, or false otherwise

    • getConstraintValidationHandler

      @NonNull dev.metaschema.core.model.constraint.IConstraintValidationHandler getConstraintValidationHandler()
      Get the constraint validation handler configured for this deserializer, which will be used to validate loaded data.
      Returns:
      the validation handler

    • setConstraintValidationHandler

      void setConstraintValidationHandler(@NonNull dev.metaschema.core.model.constraint.IConstraintValidationHandler handler)
      Set the constraint violation handler for constraint validation.
      Parameters:
      handler - the handler to use

    • deserialize

      @NonNull default CLASS deserialize(@NonNull InputStream is, @NonNull URI documentUri) throws IOException
      Read data from the InputStream into a bound class instance.
      Parameters:
      is - the input stream to read from
      documentUri - the URI of the document to read from
      Returns:
      the instance data
      Throws:
      IOException - if an error occurred while reading data from the stream

    • deserialize

      @NonNull default CLASS deserialize(@NonNull Path path) throws IOException
      Read data from the Path into a bound class instance.
      Parameters:
      path - the file to read from
      Returns:
      the instance data
      Throws:
      IOException - if an error occurred while writing data to the file indicated by the path parameter

    • deserialize

      @NonNull default CLASS deserialize(@NonNull File file) throws IOException
      Read data from the File into a bound class instance.
      Parameters:
      file - the file to read from
      Returns:
      the instance data
      Throws:
      IOException - if an error occurred while reading data from the stream

    • deserialize

      @NonNull default CLASS deserialize(@NonNull URL url) throws IOException, URISyntaxException
      Read data from the remote resource into a bound class instance.
      Parameters:
      url - the remote resource to read from
      Returns:
      the instance data
      Throws:
      IOException - if an error occurred while reading data from the stream
      URISyntaxException - if the provided URL is not formatted strictly according to to RFC2396 and cannot be converted to a URI.

    • deserialize

      @NonNull default CLASS deserialize(@NonNull Reader reader, @NonNull URI documentUri) throws IOException
      Read data from the Reader into a bound class instance.
      Parameters:
      reader - the reader to read from
      documentUri - the URI of the document to read from
      Returns:
      the instance data
      Throws:
      IOException - if an error occurred while reading data from the stream

    • deserializeToNodeItem

      @NonNull default dev.metaschema.core.metapath.item.node.INodeItem deserializeToNodeItem(@NonNull InputStream is, @NonNull URI documentUri) throws IOException
      Read data from the Reader into a node item instance.
      Parameters:
      is - the input stream to read from
      documentUri - the URI of the document to read from
      Returns:
      a new node item
      Throws:
      IOException - if an error occurred while reading data from the stream

    • deserializeToNodeItem

      @NonNull dev.metaschema.core.metapath.item.node.INodeItem deserializeToNodeItem(@NonNull Reader reader, @NonNull URI documentUri) throws IOException
      Read data from the Reader into a node item instance.
      Parameters:
      reader - the reader to read from
      documentUri - the URI of the document to read from
      Returns:
      a new node item
      Throws:
      IOException - if an error occurred while reading data from the stream

    • deserializeToValue

      @NonNull CLASS deserializeToValue(@NonNull Reader reader, @NonNull URI documentUri) throws IOException
      Read data from the Reader into a node item instance.
      Parameters:
      reader - the reader to read from
      documentUri - the URI of the document to read from
      Returns:
      a new node item
      Throws:
      IOException - if an error occurred while reading data from the stream