Package nl.knaw.dans.bagit.reader

Class BagitTextFileReader

java.lang.Object

nl.knaw.dans.bagit.reader.BagitTextFileReader

public final class BagitTextFileReader
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte[]	BOM
private static final String	LINE1_REGEX
private static final String	LINE2_REGEX
private static final org.slf4j.Logger	logger
private static final ResourceBundle	messages
private static final Version	VERSION_1_0

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BagitTextFileReader()

Method Summary

Modifier and Type	Method	Description
static Version	parseVersion(String version)
static AbstractMap.SimpleImmutableEntry<Version,Charset>	readBagitTextFile(Path bagitFile)	Read the bagit.txt file and return the version and encoding.
private static void	throwErrorIfByteOrderMarkIsPresent(Path bagitFile)
(package private) static void	throwErrorIfLinesDoNotMatchStrict(List<String> lines)

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

BOM

private static final byte[] BOM

messages

private static final ResourceBundle messages

VERSION_1_0

private static final Version VERSION_1_0

LINE1_REGEX

private static final String LINE1_REGEX

See Also:

• Constant Field Values

LINE2_REGEX

private static final String LINE2_REGEX

See Also:

• Constant Field Values

Constructor Details

BagitTextFileReader

private BagitTextFileReader()

Method Details

readBagitTextFile

public static AbstractMap.SimpleImmutableEntry<Version,Charset> readBagitTextFile(Path bagitFile)
                                                                           throws 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:

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

throwErrorIfByteOrderMarkIsPresent

private static void throwErrorIfByteOrderMarkIsPresent(Path bagitFile)
                                                throws IOException,
InvalidBagitFileFormatException

Throws:

IOException

InvalidBagitFileFormatException

throwErrorIfLinesDoNotMatchStrict

static void throwErrorIfLinesDoNotMatchStrict(List<String> lines)
                                       throws InvalidBagitFileFormatException

Throws:

InvalidBagitFileFormatException

parseVersion

public static Version parseVersion(String version)
                            throws UnparsableVersionException

Throws:

UnparsableVersionException