Class ResourceCollection

java.lang.Object

com.adobe.epubcheck.opf.ResourceCollection

public final class ResourceCollection
extends Object

Represent a collection of resources as defined by the collection element in Package Documents.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResourceCollection.Builder	A builder for ResourceCollection.
static enum	ResourceCollection.Roles	The collection roles reserved by IDPF.

Field Summary

Fields

Modifier and Type	Field	Description
private final ResourceCollections	collections
private final MetadataSet	metadata
private final LinkedResources	metadataLinks
private final LinkedResources	resources
private final Set<String>	roles

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ResourceCollection(Set<String> roles, MetadataSet metadata, LinkedResources metadataLinks, ResourceCollections collections, LinkedResources resources)

Method Summary

Modifier and Type	Method	Description
static final ResourceCollection.Builder	builder()	Creates a new builder.
ResourceCollections	getCollections()	Returns the set of this collection's sub collections.
MetadataSet	getMetadata()	Returns the metadata of this collection.
LinkedResources	getMetadataLinks()	Returns the linked resources defined as metadata in this collection.
LinkedResources	getResources()	Returns the set of this collection's resources.
Set<String>	getRoles()	Returns the roles of this collection.
boolean	hasRole(ResourceCollection.Roles role)	Returns true if this collection has the given IDPF-reserved role.
boolean	hasRole(String role)	Returns true if this collection has the given role.

Methods inherited from class Object

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

Field Details

roles

private final Set<String> roles

metadata

private final MetadataSet metadata

metadataLinks

private final LinkedResources metadataLinks

collections

private final ResourceCollections collections

resources

private final LinkedResources resources

Constructor Details

ResourceCollection

private ResourceCollection(Set<String> roles,
 MetadataSet metadata,
 LinkedResources metadataLinks,
 ResourceCollections collections,
 LinkedResources resources)

Method Details

getRoles

public Set<String> getRoles()

Returns the roles of this collection.

hasRole

public boolean hasRole(String role)

Returns true if this collection has the given role.

hasRole

public boolean hasRole(ResourceCollection.Roles role)

Returns true if this collection has the given IDPF-reserved role.

getMetadata

public MetadataSet getMetadata()

Returns the metadata of this collection. Guaranteed non-null (can be empty).

getMetadataLinks

public LinkedResources getMetadataLinks()

Returns the linked resources defined as metadata in this collection. Guaranteed non-null (can be empty).

getCollections

public ResourceCollections getCollections()

Returns the set of this collection's sub collections. Guaranteed non-null (can be empty).

getResources

public LinkedResources getResources()

Returns the set of this collection's resources. Guaranteed non-null (can be empty).

builder

public static final ResourceCollection.Builder builder()

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

Returns:

a newly created builder.