gov.loc.repository.bagit.reader

Class KeyValueReader

java.lang.Object

gov.loc.repository.bagit.reader.KeyValueReader

public final class KeyValueReader
extends java.lang.Object

Convenience class for reading key value pairs from a file

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.util.AbstractMap.SimpleImmutableEntry<java.lang.String,java.lang.String>>	readKeyValuesFromFile(java.nio.file.Path file, java.lang.String splitRegex, java.nio.charset.Charset charset) Generic method to read key value pairs from the bagit files, like bagit.txt or bag-info.txt

Methods inherited from class java.lang.Object

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

Method Detail

readKeyValuesFromFile

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

Generic method to read key value pairs from the bagit files, like bagit.txt or bag-info.txt

Parameters:

file - the file to read

splitRegex - how to split the key from the value

charset - the encoding of the file

Returns:

a list of key value pairs

Throws:

java.io.IOException - if there was a problem reading the file

InvalidBagMetadataException - if the file does not conform to pattern of key value