Package org.apache.maven.artifact.repository.metadata.io

Interface MetadataReader

All Known Implementing Classes:
DefaultMetadataReader
public interface MetadataReader
Handles deserialization of metadata from some kind of textual format like XML.
Author:
Benjamin Bentmann

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    IS_STRICT
    The key for the option to enable strict parsing.

  • Method Summary

    Modifier and Type
    Method
    Description
    Metadata
    read(File input, Map<String,?> options)
    Reads the metadata from the specified file.
    Metadata
    read(InputStream input, Map<String,?> options)
    Reads the metadata from the specified byte stream.
    Metadata
    read(Reader input, Map<String,?> options)
    Reads the metadata from the specified character reader.

  • Field Details

    • IS_STRICT

      static final String IS_STRICT
      The key for the option to enable strict parsing. This option is of type Boolean and defaults to true. If false, unknown elements will be ignored instead of causing a failure.
      See Also:

  • Method Details

    • read

      Metadata read(File input, Map<String,?> options) throws IOException, MetadataParseException
      Reads the metadata from the specified file.
      Parameters:
      input - The file to deserialize the metadata from, must not be null.
      options - The options to use for deserialization, may be null to use the default values.
      Returns:
      The deserialized metadata, never null.
      Throws:
      IOException - If the metadata could not be deserialized.
      MetadataParseException - If the input format could not be parsed.

    • read

      Metadata read(Reader input, Map<String,?> options) throws IOException, MetadataParseException
      Reads the metadata from the specified character reader. The reader will be automatically closed before the method returns.
      Parameters:
      input - The reader to deserialize the metadata from, must not be null.
      options - The options to use for deserialization, may be null to use the default values.
      Returns:
      The deserialized metadata, never null.
      Throws:
      IOException - If the metadata could not be deserialized.
      MetadataParseException - If the input format could not be parsed.

    • read

      Metadata read(InputStream input, Map<String,?> options) throws IOException, MetadataParseException
      Reads the metadata from the specified byte stream. The stream will be automatically closed before the method returns.
      Parameters:
      input - The stream to deserialize the metadata from, must not be null.
      options - The options to use for deserialization, may be null to use the default values.
      Returns:
      The deserialized metadata, never null.
      Throws:
      IOException - If the metadata could not be deserialized.
      MetadataParseException - If the input format could not be parsed.