All Implemented Interfaces:

org.readium.r2.shared.publication.PublicationServicesHolder , org.readium.r2.shared.util.SuspendingCloseable
```
public final class Publication
 implements PublicationServicesHolder
                    
```
The Publication shared model is the entry-point for all the metadata and services related to a Readium publication.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`Publication.TYPE`
`public enum`	`Publication.EXTENSION`
`public class`	`Publication.Companion`
`public final class`	`Publication.Profile`	Represents a Readium Web Publication Profile a Publication can conform to. For a list of supported profiles, see the registry: https://readium.org/webpub-manifest/profiles/
`public interface`	`Publication.Service`	Base interface to be implemented by all publication services.
`public final class`	`Publication.ServicesBuilder`	Builds a list of Publication.Service from a collection of service factories. Provides helpers to manipulate the list of services of a Publication.
`public final class`	`Publication.Builder`	Builds a Publication from its components. A Publication's construction is distributed over the Streamer and its parsers, so a builder is useful to pass the parts around.
`public interface`	`Publication.PositionListFactory`
`public class`	`Publication.OpeningException`

Field Summary

Fields
Modifier and Type	Field	Description
`private final List<String>`	`context`
`private final Metadata`	`metadata`
`private final List<Link>`	`links`
`private final List<Link>`	`readingOrder`
`private final List<Link>`	`resources`
`private final List<Link>`	`tableOfContents`
`private final Map<String, List<PublicationCollection>>`	`subcollections`
`private Publication.TYPE`	`type`
`private Double`	`version`
`private final String`	`jsonManifest`
`private final Url`	`baseUrl`
`private final Link`	`coverLink`
`private final List<Link>`	`listOfAudioFiles`
`private final List<Link>`	`listOfVideos`
`private final Map<String, List<PublicationCollection>>`	`otherCollections`
`private final ReadingProgression`	`contentLayout`
`private final Manifest`	`manifest`
`private Map<ReadiumCSSName, Boolean>`	`userSettingsUIPreset`
`private String`	`cssStyle`

Constructor Summary

Constructors
Constructor	Description
`Publication(Manifest manifest, Container<Resource> container, Publication.ServicesBuilder servicesBuilder, Map<ReadiumCSSName, Boolean> userSettingsUIPreset, String cssStyle)`

Method Summary

Modifier and Type	Method	Description
`final List<String>`	`getContext()`
`final Metadata`	`getMetadata()`
`final List<Link>`	`getLinks()`
`final List<Link>`	`getReadingOrder()`
`final List<Link>`	`getResources()`
`final List<Link>`	`getTableOfContents()`
`final Map<String, List<PublicationCollection>>`	`getSubcollections()`
`final Publication.TYPE`	`getType()`
`final Unit`	`setType(@Deprecated(message = Use conformsTo() to check the kind of a publication., level = DeprecationLevel.ERROR) Publication.TYPE type)`
`final Double`	`getVersion()`
`final Unit`	`setVersion(@Deprecated(message = Version is not available any more., level = DeprecationLevel.ERROR) Double version)`
`final String`	`getJsonManifest()`
`final Url`	`getBaseUrl()`
`final Link`	`getCoverLink()`
`final List<Link>`	`getListOfAudioFiles()`
`final List<Link>`	`getListOfVideos()`
`final Map<String, List<PublicationCollection>>`	`getOtherCollections()`
`final ReadingProgression`	`getContentLayout()`
`final Manifest`	`getManifest()`
`final Map<ReadiumCSSName, Boolean>`	`getUserSettingsUIPreset()`
`final Unit`	`setUserSettingsUIPreset(@Deprecated(message = Migrate to the new Settings API (see migration guide), level = DeprecationLevel.ERROR) Map<ReadiumCSSName, Boolean> userSettingsUIPreset)`
`final String`	`getCssStyle()`
`final Unit`	`setCssStyle(@Deprecated(message = Migrate to the new Settings API (see migration guide), level = DeprecationLevel.ERROR) String cssStyle)`
`final Url`	`url(Locator locator)`	Returns the URL to the resource represented by the given locator, relative to the publication's link with `self` relation.
`final Url`	`url(Link link, Map<String, String> parameters)`	Returns the URL to the resource represented by the given link, relative to the publication's link with `self` relation.
`final Url`	`url(Href href, Map<String, String> parameters)`	Returns the URL to the resource represented by the given href, relative to the publication's link with `self` relation.
`final Boolean`	`conformsTo(Publication.Profile profile)`	Returns whether this publication conforms to the given Readium Web Publication Profile.
`final Link`	`linkWithHref(Url href)`	Finds the first Link with the given HREF in the publication's links.
`final Link`	`linkWithRel(String rel)`	Finds the first Link having the given rel in the publications's links.
`final List<Link>`	`linksWithRel(String rel)`	Finds all Links having the given rel in the publications's links.
`final Locator`	`locatorFromLink(Link link)`	Creates a new Locator object from a Link to a resource of this publication.
`final Resource`	`get(Link link)`	Returns the resource targeted by the given non-templated link.
`final Resource`	`get(Url href)`	Returns the resource targeted by the given href.
`Unit`	`close()`	Closes any opened resource associated with the Publication, including services.
`<T extends Publication.Service> T`	`findService(KClass<T> serviceType)`	Returns the first publication service that is an instance of serviceType.
`<T extends Publication.Service> List<T>`	`findServices(KClass<T> serviceType)`	Returns all the publication services that are instances of serviceType.
`final Unit`	`setSelfLink(String href)`	Sets the URL where this Publication's RWPM manifest is served.
`final Publication`	`copyWithPositionsFactory()`	Copy the Publication with a different PositionListFactory.
`final Link`	`resource(String href)`
`final URL`	`baseUrl()`
`final Unit`	`addSelfLink(String endPoint, URL baseURL)`
`final Link`	`resourceWithHref(String href)`
`final Link`	`link(Function1<Link, Boolean> predicate)`
`final JSONObject`	`toJSON()`
`final ReadingProgression`	`contentLayoutForLanguage(String language)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Publication
```
Publication(Manifest manifest, Container<Resource> container, Publication.ServicesBuilder servicesBuilder, Map<ReadiumCSSName, Boolean> userSettingsUIPreset, String cssStyle)
```
  Parameters:
  
  manifest - The manifest holding the publication metadata extracted from the publication file.
  
  container - The underlying container used to read publication resources.
  
  servicesBuilder - Holds the list of service factories used to create the instances of Publication.Service attached to this Publication.

Method Detail

getContext
```
 final List<String> getContext()
```

getMetadata
```
 final Metadata getMetadata()
```

getLinks
```
 final List<Link> getLinks()
```

getReadingOrder
```
 final List<Link> getReadingOrder()
```

getResources
```
 final List<Link> getResources()
```

getTableOfContents
```
 final List<Link> getTableOfContents()
```

getSubcollections

 final Map<String, List<PublicationCollection>> getSubcollections()

getType
```
 final Publication.TYPE getType()
```

setType

 final Unit setType(@Deprecated(message = Use conformsTo() to check the kind of a publication., level = DeprecationLevel.ERROR) Publication.TYPE type)

getVersion
```
 final Double getVersion()
```

setVersion

 final Unit setVersion(@Deprecated(message = Version is not available any more., level = DeprecationLevel.ERROR) Double version)

getJsonManifest
```
 final String getJsonManifest()
```

getBaseUrl
```
 final Url getBaseUrl()
```

getCoverLink
```
 final Link getCoverLink()
```

getListOfAudioFiles
```
 final List<Link> getListOfAudioFiles()
```

getListOfVideos
```
 final List<Link> getListOfVideos()
```

getOtherCollections

 final Map<String, List<PublicationCollection>> getOtherCollections()

getContentLayout

 final ReadingProgression getContentLayout()

getManifest
```
 final Manifest getManifest()
```

getUserSettingsUIPreset

 final Map<ReadiumCSSName, Boolean> getUserSettingsUIPreset()

setUserSettingsUIPreset

 final Unit setUserSettingsUIPreset(@Deprecated(message = Migrate to the new Settings API (see migration guide), level = DeprecationLevel.ERROR) Map<ReadiumCSSName, Boolean> userSettingsUIPreset)

getCssStyle
```
 final String getCssStyle()
```

setCssStyle

 final Unit setCssStyle(@Deprecated(message = Migrate to the new Settings API (see migration guide), level = DeprecationLevel.ERROR) String cssStyle)

url
```
 final Url url(Locator locator)
```
Returns the URL to the resource represented by the given locator, relative to the publication's link with self relation.

url
```
 final Url url(Link link, Map<String, String> parameters)
```
Returns the URL to the resource represented by the given link, relative to the publication's link with self relation.
If the link HREF is a template, the parameters are used to expand it according to RFC 6570.

url
```
 final Url url(Href href, Map<String, String> parameters)
```
Returns the URL to the resource represented by the given href, relative to the publication's link with self relation.
If the HREF is a template, the parameters are used to expand it according to RFC 6570.

conformsTo
```
 final Boolean conformsTo(Publication.Profile profile)
```
Returns whether this publication conforms to the given Readium Web Publication Profile.

linkWithHref
```
 final Link linkWithHref(Url href)
```
Finds the first Link with the given HREF in the publication's links.
Searches through (in order) readingOrder, resources and links recursively following alternate and children links.
If there's no match, tries again after removing any query parameter and anchor from the given href.

linkWithRel
```
 final Link linkWithRel(String rel)
```
Finds the first Link having the given rel in the publications's links.

linksWithRel
```
 final List<Link> linksWithRel(String rel)
```
Finds all Links having the given rel in the publications's links.

locatorFromLink
```
 final Locator locatorFromLink(Link link)
```
Creates a new Locator object from a Link to a resource of this publication.
Returns null if the resource is not found in this publication.

get
```
 final Resource get(Link link)
```
Returns the resource targeted by the given non-templated link.

get
```
 final Resource get(Url href)
```
Returns the resource targeted by the given href.

close
```
 Unit close()
```
Closes any opened resource associated with the Publication, including services.

findService
```
 <T extends Publication.Service> T findService(KClass<T> serviceType)
```
Returns the first publication service that is an instance of serviceType.

findServices
```
 <T extends Publication.Service> List<T> findServices(KClass<T> serviceType)
```
Returns all the publication services that are instances of serviceType.

setSelfLink
```
 final Unit setSelfLink(String href)
```
Sets the URL where this Publication's RWPM manifest is served.

copyWithPositionsFactory
```
 final Publication copyWithPositionsFactory()
```
Copy the Publication with a different PositionListFactory. The provided closure will be used to build the PositionListFactory, with this being the Publication.

resource
```
 final Link resource(String href)
```

baseUrl
```
 final URL baseUrl()
```

addSelfLink

 final Unit addSelfLink(String endPoint, URL baseURL)

resourceWithHref

 final Link resourceWithHref(String href)

link

 final Link link(Function1<Link, Boolean> predicate)

toJSON
```
 final JSONObject toJSON()
```

contentLayoutForLanguage

 final ReadingProgression contentLayoutForLanguage(String language)

Class Publication

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Publication

Method Detail

getContext

getMetadata

getLinks

getReadingOrder

getResources

getTableOfContents

getSubcollections

getType

setType

getVersion

setVersion

getJsonManifest

getBaseUrl

getCoverLink

getListOfAudioFiles

getListOfVideos

getOtherCollections

getContentLayout

getManifest

getUserSettingsUIPreset

setUserSettingsUIPreset

getCssStyle

setCssStyle

url

url

url

conformsTo

linkWithHref

linkWithRel

linksWithRel

locatorFromLink

get

get

close

findService

findServices

setSelfLink

copyWithPositionsFactory

resource

baseUrl

addSelfLink

resourceWithHref

link

toJSON

contentLayoutForLanguage