gov.loc.repository.bagit.reader

Class MetadataReader

java.lang.Object

gov.loc.repository.bagit.reader.MetadataReader

public final class MetadataReader
extends java.lang.Object

This class is responsible for reading and parsing bagit metadata files from the filesystem

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.util.AbstractMap.SimpleImmutableEntry<java.lang.String,java.lang.String>>	readBagMetadata(java.nio.file.Path rootDir, java.nio.charset.Charset encoding) Reads the bag metadata file (bag-info.txt or package-info.txt) and returns it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

readBagMetadata

public static java.util.List<java.util.AbstractMap.SimpleImmutableEntry<java.lang.String,java.lang.String>> readBagMetadata(java.nio.file.Path rootDir,
                                                                                                                            java.nio.charset.Charset encoding)
                                                                                                                     throws java.io.IOException,
                                                                                                                            InvalidBagMetadataException

Reads the bag metadata file (bag-info.txt or package-info.txt) and returns it.

Parameters:

rootDir - the root directory of the bag

encoding - the encoding of the bagit.txt file

Returns:

the bag-info.txt (metadata) information

Throws:

java.io.IOException - if there is a problem reading a file

InvalidBagMetadataException - if the metadata file does not conform to the bagit spec