Package com.io7m.sunburst.inventory.internal

Class SBInventory

java.lang.Object

com.io7m.sunburst.inventory.internal.SBInventory

All Implemented Interfaces:

SBInventoryReadableType, SBInventoryType, AutoCloseable

public final class SBInventory
extends Object
implements SBInventoryType

The default inventory.

Method Summary

Modifier and Type	Method	Description
void	close()
SBInventoryConfiguration	configuration()
static SBInventoryReadableType	openReadOnly(SBStrings strings, com.io7m.mime2045.parser.api.MimeParserFactoryType mimeParsers, SBInventoryConfiguration configuration)	Open the inventory in read-only mode.
static SBInventoryType	openReadWrite(SBStrings strings, com.io7m.mime2045.parser.api.MimeParserFactoryType mimeParsers, SBInventoryConfiguration configuration)	Open the inventory in read-write mode.
SBTransactionType	openTransaction()
SBTransactionReadableType	openTransactionReadable()

Methods inherited from class java.lang.Object

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

Method Details

openReadOnly

public static SBInventoryReadableType openReadOnly(SBStrings strings,
 com.io7m.mime2045.parser.api.MimeParserFactoryType mimeParsers,
 SBInventoryConfiguration configuration)
                                            throws SBInventoryException

Open the inventory in read-only mode.

Parameters:

strings - The string resources

mimeParsers -

configuration - The configuration

Returns:

A readable inventory

Throws:

SBInventoryException - On errors

openReadWrite

public static SBInventoryType openReadWrite(SBStrings strings,
 com.io7m.mime2045.parser.api.MimeParserFactoryType mimeParsers,
 SBInventoryConfiguration configuration)
                                     throws SBInventoryException

Open the inventory in read-write mode.

Parameters:

strings - The string resources

mimeParsers -

configuration - The configuration

Returns:

An inventory

Throws:

SBInventoryException - On errors

openTransaction

public SBTransactionType openTransaction()
                                  throws SBInventoryException

Specified by:

openTransaction in interface SBInventoryType

Returns:

A new transaction

Throws:

SBInventoryException

configuration

public SBInventoryConfiguration configuration()

Specified by:

configuration in interface SBInventoryReadableType

Returns:

The inventory configuration

openTransactionReadable

public SBTransactionReadableType openTransactionReadable()
                                                  throws SBInventoryException

Specified by:

openTransactionReadable in interface SBInventoryReadableType

Returns:

A new transaction for reading

Throws:

SBInventoryException - On errors

close

public void close()
           throws SBInventoryException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SBInventoryReadableType

Throws:

SBInventoryException