Package edu.wisc.library.ocfl.core.inventory

Class InventoryMapper

java.lang.Object

edu.wisc.library.ocfl.core.inventory.InventoryMapper

public class InventoryMapper
extends Object

Wrapper around Jackson's ObjectMapper for serializing and deserializing Inventories. The ObjectMapper setup is a finicky and I do not recommend changing it unless you are sure you know what you're doing.

Constructor Summary

Constructors

Constructor	Description
InventoryMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Should use InventoryMapper.defaultMapper() or InventoryMapper.prettyPrintMapper() unless you know what you're doing.

Method Summary

Modifier and Type	Method	Description
static InventoryMapper	defaultMapper()	Creates an InventoryMapper that creates JSON files with as little whitespace as possible.
static InventoryMapper	prettyPrintMapper()	Creates an InventoryMapper that will pretty print JSON files.
Inventory	read(String objectRootPath, DigestAlgorithm digestAlgorithm, InputStream inputStream)
Inventory	read(String objectRootPath, DigestAlgorithm digestAlgorithm, Path path)
Inventory	readMutableHead(String objectRootPath, RevisionNum revisionNum, DigestAlgorithm digestAlgorithm, InputStream inputStream)
Inventory	readMutableHead(String objectRootPath, RevisionNum revisionNum, DigestAlgorithm digestAlgorithm, Path path)
Inventory	readMutableHeadNoDigest(String objectRootPath, RevisionNum revisionNum, InputStream inputStream)
Inventory	readMutableHeadNoDigest(String objectRootPath, RevisionNum revisionNum, Path path)
Inventory	readNoDigest(String objectRootPath, InputStream inputStream)
Inventory	readNoDigest(String objectRootPath, Path path)
void	write(OutputStream outputStream, Inventory inventory)
void	write(Path destination, Inventory inventory)

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryMapper

public InventoryMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Should use InventoryMapper.defaultMapper() or InventoryMapper.prettyPrintMapper() unless you know what you're doing.

Parameters:

objectMapper - object mapper

Method Detail

prettyPrintMapper

public static InventoryMapper prettyPrintMapper()

Creates an InventoryMapper that will pretty print JSON files. This should be used when you value human readability over disk space usage.

Returns:

mapper

defaultMapper

public static InventoryMapper defaultMapper()

Creates an InventoryMapper that creates JSON files with as little whitespace as possible. This should be used when minimizing disk space usage is more important than human readability.

Returns:

mapper

write

public void write(Path destination,
                  Inventory inventory)

write

public void write(OutputStream outputStream,
                  Inventory inventory)

read

public Inventory read(String objectRootPath,
                      DigestAlgorithm digestAlgorithm,
                      Path path)

read

public Inventory read(String objectRootPath,
                      DigestAlgorithm digestAlgorithm,
                      InputStream inputStream)

readMutableHead

public Inventory readMutableHead(String objectRootPath,
                                 RevisionNum revisionNum,
                                 DigestAlgorithm digestAlgorithm,
                                 Path path)

readMutableHead

public Inventory readMutableHead(String objectRootPath,
                                 RevisionNum revisionNum,
                                 DigestAlgorithm digestAlgorithm,
                                 InputStream inputStream)

readNoDigest

public Inventory readNoDigest(String objectRootPath,
                              Path path)

readNoDigest

public Inventory readNoDigest(String objectRootPath,
                              InputStream inputStream)

readMutableHeadNoDigest

public Inventory readMutableHeadNoDigest(String objectRootPath,
                                         RevisionNum revisionNum,
                                         Path path)

readMutableHeadNoDigest

public Inventory readMutableHeadNoDigest(String objectRootPath,
                                         RevisionNum revisionNum,
                                         InputStream inputStream)