Class OPFItems

java.lang.Object

com.adobe.epubcheck.opf.OPFItems

public final class OPFItems
extends Object

Represents the set of Publication Resources in a Package Document (OPF).

Field Summary

Fields

Modifier and Type	Field	Description
private final List<OPFItem>	items
private final Map<String,OPFItem>	itemsById
private final Map<io.mola.galimatias.URL, OPFItem>	itemsByURL
private final List<OPFItem>	spine

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OPFItems(Iterable<OPFItem> items, Iterable<String> spineIDs)

Method Summary

Modifier and Type	Method	Description
static OPFItems	build(Map<String, OPFItem.Builder> itemBuilders, Iterable<String> spineIDs, ValidationContext context)	Creates a consolidated set of OPFItem from item builders and a list of spine item IDs.
com.google.common.base.Optional<OPFItem>	getItemById(String id)	Search the item with the given ID.
com.google.common.base.Optional<OPFItem>	getItemByURL(io.mola.galimatias.URL url)	Search the item with the given path.
List<OPFItem>	getItems()	Returns the list of items in this set, in document order.
List<OPFItem>	getSpineItems()	Returns the list of items in the spine.

Methods inherited from class Object

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

Field Details

items

private final List<OPFItem> items

spine

private final List<OPFItem> spine

itemsById

private final Map<String,OPFItem> itemsById

itemsByURL

private final Map<io.mola.galimatias.URL, OPFItem> itemsByURL

Constructor Details

OPFItems

private OPFItems(Iterable<OPFItem> items,
 Iterable<String> spineIDs)

Method Details

getItemById

public com.google.common.base.Optional<OPFItem> getItemById(String id)

Search the item with the given ID.

Parameters:

id - the ID of the item to search, can be null.

Returns:

An Optional containing the item if found, or Optional.absent() if not found.

getItemByURL

public com.google.common.base.Optional<OPFItem> getItemByURL(io.mola.galimatias.URL url)

Search the item with the given path.

Parameters:

id - the URL of the item to search, can be null.

Returns:

An Optional containing the item if found, or Optional.absent() if not found.

getSpineItems

public List<OPFItem> getSpineItems()

Returns the list of items in the spine. A single OPFItem instance can appear multiple times in the list.

Returns:

the list of items in the spine.

getItems

public List<OPFItem> getItems()

Returns the list of items in this set, in document order.

Returns:

the list of items in this set.

build

public static OPFItems build(Map<String, OPFItem.Builder> itemBuilders,
 Iterable<String> spineIDs,
 ValidationContext context)

Creates a consolidated set of OPFItem from item builders and a list of spine item IDs.

Parameters:

itemBuilders - the builders of the OPFItem in the set.

spineIDs - the IDs of the items in the spine.

context -

Returns:

a consolidated set of OPFItems.