gov.loc.repository.bagit.reader

Class BagitTextFileReader

java.lang.Object

gov.loc.repository.bagit.reader.BagitTextFileReader

public final class BagitTextFileReader
extends java.lang.Object

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

Method Summary

Modifier and Type	Method and Description
static Version	parseVersion(java.lang.String version)
static java.util.AbstractMap.SimpleImmutableEntry<Version,java.nio.charset.Charset>	readBagitTextFile(java.nio.file.Path bagitFile) Read the bagit.txt file and return the version and encoding.

Methods inherited from class java.lang.Object

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

Method Detail

readBagitTextFile

public static java.util.AbstractMap.SimpleImmutableEntry<Version,java.nio.charset.Charset> readBagitTextFile(java.nio.file.Path bagitFile)
                                                                                                      throws java.io.IOException,
                                                                                                             UnparsableVersionException,
                                                                                                             InvalidBagMetadataException,
                                                                                                             InvalidBagitFileFormatException

Read the bagit.txt file and return the version and encoding.

Parameters:

bagitFile - the bagit.txt file

Returns:

the bag Version and Charset encoding of the tag files

Throws:

java.io.IOException - if there is a problem reading a file. The file MUST be in UTF-8 encoding.

UnparsableVersionException - if there is a problem parsing the bagit version number

InvalidBagMetadataException - if the bagit.txt file does not conform to "key: value"

InvalidBagitFileFormatException - if the bagit.txt file does not conform to the bagit spec

parseVersion

public static Version parseVersion(java.lang.String version)
                            throws UnparsableVersionException

Throws:

UnparsableVersionException