Interface MetadataReader
-
- All Known Implementing Classes:
DefaultMetadataReader
public interface MetadataReader
Handles deserialization of metadata from some kind of textual format like XML.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
IS_STRICT
The key for the option to enable strict parsing.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Metadata
read(java.io.File input, java.util.Map<java.lang.String,?> options)
Reads the metadata from the specified file.Metadata
read(java.io.InputStream input, java.util.Map<java.lang.String,?> options)
Reads the metadata from the specified byte stream.Metadata
read(java.io.Reader input, java.util.Map<java.lang.String,?> options)
Reads the metadata from the specified character reader.
-
-
-
Field Detail
-
IS_STRICT
static final java.lang.String IS_STRICT
The key for the option to enable strict parsing. This option is of typeBoolean
and defaults totrue
. Iffalse
, unknown elements will be ignored instead of causing a failure.- See Also:
- Constant Field Values
-
-
Method Detail
-
read
Metadata read(java.io.File input, java.util.Map<java.lang.String,?> options) throws java.io.IOException, MetadataParseException
Reads the metadata from the specified file.- Parameters:
input
- The file to deserialize the metadata from, must not benull
.options
- The options to use for deserialization, may benull
to use the default values.- Returns:
- The deserialized metadata, never
null
. - Throws:
java.io.IOException
- If the metadata could not be deserialized.MetadataParseException
- If the input format could not be parsed.
-
read
Metadata read(java.io.Reader input, java.util.Map<java.lang.String,?> options) throws java.io.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 benull
.options
- The options to use for deserialization, may benull
to use the default values.- Returns:
- The deserialized metadata, never
null
. - Throws:
java.io.IOException
- If the metadata could not be deserialized.MetadataParseException
- If the input format could not be parsed.
-
read
Metadata read(java.io.InputStream input, java.util.Map<java.lang.String,?> options) throws java.io.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 benull
.options
- The options to use for deserialization, may benull
to use the default values.- Returns:
- The deserialized metadata, never
null
. - Throws:
java.io.IOException
- If the metadata could not be deserialized.MetadataParseException
- If the input format could not be parsed.
-
-