Class ResourceCollections

java.lang.Object

com.adobe.epubcheck.opf.ResourceCollections

public final class ResourceCollections
extends Object

Represents a set of collections (as defined by collection elements in a Package Document), with predictable iteration order.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResourceCollections.Builder	A builder for ResourceCollections.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<ResourceCollection>	collections
private final com.google.common.collect.ListMultimap<String, ResourceCollection>	collectionsByRole

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ResourceCollections(Iterable<ResourceCollection> collections)

Method Summary

Modifier and Type	Method	Description
List<ResourceCollection>	asList()	Returns the list of all collections in this set.
static final ResourceCollections.Builder	builder()	Creates a new builder.
List<ResourceCollection>	getByRole(ResourceCollection.Roles role)	Returns the list of collections in this set with the given IDPF-reserved role.
List<ResourceCollection>	getByRole(String role)	Returns the list of collections in this set with the given role.
boolean	hasRole(ResourceCollection.Roles role)	Returns true if this set contains one or more collections with the given IDPF-reserved role.
boolean	hasRole(String role)	Returns true if this set contains one or more collections with the given role.

Methods inherited from class Object

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

Field Details

collections

private final List<ResourceCollection> collections

collectionsByRole

private final com.google.common.collect.ListMultimap<String, ResourceCollection> collectionsByRole

Constructor Details

ResourceCollections

private ResourceCollections(Iterable<ResourceCollection> collections)

Method Details

asList

public List<ResourceCollection> asList()

Returns the list of all collections in this set.

getByRole

public List<ResourceCollection> getByRole(String role)

Returns the list of collections in this set with the given role.

getByRole

public List<ResourceCollection> getByRole(ResourceCollection.Roles role)

Returns the list of collections in this set with the given IDPF-reserved role.

hasRole

public boolean hasRole(String role)

Returns true if this set contains one or more collections with the given role.

hasRole

public boolean hasRole(ResourceCollection.Roles role)

Returns true if this set contains one or more collections with the given IDPF-reserved role.

builder

public static final ResourceCollections.Builder builder()

Creates a new builder. Calling this method is identical to calling the empty ResourceCollections.Builder constructor.

Returns:

a newly created builder.