Package nl.knaw.dans.bagit.reader

Class MetadataReader

java.lang.Object

nl.knaw.dans.bagit.reader.MetadataReader

public final class MetadataReader
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	logger
private static final ResourceBundle	messages

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MetadataReader()

Method Summary

Modifier and Type	Method	Description
static List<AbstractMap.SimpleImmutableEntry<String,String>>	readBagMetadata(Path rootDir, 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

Field Details

logger

private static final org.slf4j.Logger logger

messages

private static final ResourceBundle messages

Constructor Details

MetadataReader

private MetadataReader()

Method Details

readBagMetadata

public static List<AbstractMap.SimpleImmutableEntry<String,String>> readBagMetadata(Path rootDir,
 Charset encoding)
                                                                             throws 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:

IOException - if there is a problem reading a file

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