All Implemented Interfaces:

android.os.Parcelable , org.readium.r2.shared.JSONable
```
public final class Metadata
 implements JSONable, Parcelable
                    
```
https://readium.org/webpub-manifest/schema/metadata.schema.json

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Metadata.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`title`
`private final String`	`sortAs`
`private final List<Contributor>`	`belongsToCollections`
`private final List<Contributor>`	`belongsToSeries`
`private final Language`	`language`
`private final ReadingProgression`	`effectiveReadingProgression`
`private final String`	`rdfType`
`private final LocalizedString`	`multilanguageTitle`
`private final String`	`direction`
`private final String`	`publicationDate`
`private final Presentation`	`rendition`
`private final String`	`source`
`private final String`	`rights`
`private final String`	`identifier`
`private final String`	`type`
`private final Set<Publication.Profile>`	`conformsTo`
`private final LocalizedString`	`localizedTitle`
`private final LocalizedString`	`localizedSubtitle`
`private final LocalizedString`	`localizedSortAs`
`private final Instant`	`modified`
`private final Instant`	`published`
`private final Accessibility`	`accessibility`
`private final List<String>`	`languages`
`private final List<Subject>`	`subjects`
`private final List<Contributor>`	`authors`
`private final List<Contributor>`	`translators`
`private final List<Contributor>`	`editors`
`private final List<Contributor>`	`artists`
`private final List<Contributor>`	`illustrators`
`private final List<Contributor>`	`letterers`
`private final List<Contributor>`	`pencilers`
`private final List<Contributor>`	`colorists`
`private final List<Contributor>`	`inkers`
`private final List<Contributor>`	`narrators`
`private final List<Contributor>`	`contributors`
`private final List<Contributor>`	`publishers`
`private final List<Contributor>`	`imprints`
`private final ReadingProgression`	`readingProgression`
`private final String`	`description`
`private final Double`	`duration`
`private final Integer`	`numberOfPages`
`private final Map<String, List<Contributor>>`	`belongsTo`
`private final Map<String, Object>`	`otherMetadata`

Constructor Summary

Constructors
Constructor	Description
Metadata(String identifier, String type, Set<Publication.Profile> conformsTo, LocalizedString localizedTitle, LocalizedString localizedSubtitle, LocalizedString localizedSortAs, Instant modified, Instant published, Accessibility accessibility, List<String> languages, List<Subject> subjects, List<Contributor> authors, List<Contributor> translators, List<Contributor> editors, List<Contributor> artists, List<Contributor> illustrators, List<Contributor> letterers, List<Contributor> pencilers, List<Contributor> colorists, List<Contributor> inkers, List<Contributor> narrators, List<Contributor> contributors, List<Contributor> publishers, List<Contributor> imprints, ReadingProgression readingProgression, String description, Double duration, Integer numberOfPages, Map<String, List<Contributor>> belongsTo, List<Contributor> belongsToCollections, List<Contributor> belongsToSeries, Map<String, Object> otherMetadata)
Metadata(String identifier, String type, Set<Publication.Profile> conformsTo, LocalizedString localizedTitle, LocalizedString localizedSubtitle, LocalizedString localizedSortAs, Instant modified, Instant published, Accessibility accessibility, List<String> languages, List<Subject> subjects, List<Contributor> authors, List<Contributor> translators, List<Contributor> editors, List<Contributor> artists, List<Contributor> illustrators, List<Contributor> letterers, List<Contributor> pencilers, List<Contributor> colorists, List<Contributor> inkers, List<Contributor> narrators, List<Contributor> contributors, List<Contributor> publishers, List<Contributor> imprints, ReadingProgression readingProgression, String description, Double duration, Integer numberOfPages, Map<String, List<Contributor>> belongsTo, Map<String, Object> otherMetadata)

Method Summary

Modifier and Type	Method	Description
`final String`	`getTitle()`
`final String`	`getSortAs()`
`final List<Contributor>`	`getBelongsToCollections()`
`final List<Contributor>`	`getBelongsToSeries()`
`final Language`	`getLanguage()`	Returns the Language resolved from the declared BCP 47 primary language.
`final ReadingProgression`	`getEffectiveReadingProgression()`
`final String`	`getRdfType()`
`final LocalizedString`	`getMultilanguageTitle()`
`final String`	`getDirection()`
`final String`	`getPublicationDate()`
`final Presentation`	`getRendition()`
`final String`	`getSource()`
`final String`	`getRights()`
`final String`	`getIdentifier()`
`final String`	`getType()`
`final Set<Publication.Profile>`	`getConformsTo()`
`final LocalizedString`	`getLocalizedTitle()`
`final LocalizedString`	`getLocalizedSubtitle()`
`final LocalizedString`	`getLocalizedSortAs()`
`final Instant`	`getModified()`
`final Instant`	`getPublished()`
`final Accessibility`	`getAccessibility()`
`final List<String>`	`getLanguages()`
`final List<Subject>`	`getSubjects()`
`final List<Contributor>`	`getAuthors()`
`final List<Contributor>`	`getTranslators()`
`final List<Contributor>`	`getEditors()`
`final List<Contributor>`	`getArtists()`
`final List<Contributor>`	`getIllustrators()`
`final List<Contributor>`	`getLetterers()`
`final List<Contributor>`	`getPencilers()`
`final List<Contributor>`	`getColorists()`
`final List<Contributor>`	`getInkers()`
`final List<Contributor>`	`getNarrators()`
`final List<Contributor>`	`getContributors()`
`final List<Contributor>`	`getPublishers()`
`final List<Contributor>`	`getImprints()`
`final ReadingProgression`	`getReadingProgression()`
`final String`	`getDescription()`
`final Double`	`getDuration()`
`final Integer`	`getNumberOfPages()`
`final Map<String, List<Contributor>>`	`getBelongsTo()`
`final Map<String, Object>`	`getOtherMetadata()`
`JSONObject`	`toJSON()`	Serializes a Metadata to its RWPM JSON representation.
`final Object`	`get(String key)`	Syntactic sugar to access the otherMetadata values by subscripting Metadata directly.
`final String`	`titleForLang(String key)`
`final JSONObject`	`writeJSON()`

Methods inherited from class org.readium.r2.shared.publication.Metadata
describeContents, writeToParcel
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Metadata

Metadata(String identifier, String type, Set<Publication.Profile> conformsTo, LocalizedString localizedTitle, LocalizedString localizedSubtitle, LocalizedString localizedSortAs, Instant modified, Instant published, Accessibility accessibility, List<String> languages, List<Subject> subjects, List<Contributor> authors, List<Contributor> translators, List<Contributor> editors, List<Contributor> artists, List<Contributor> illustrators, List<Contributor> letterers, List<Contributor> pencilers, List<Contributor> colorists, List<Contributor> inkers, List<Contributor> narrators, List<Contributor> contributors, List<Contributor> publishers, List<Contributor> imprints, ReadingProgression readingProgression, String description, Double duration, Integer numberOfPages, Map<String, List<Contributor>> belongsTo, List<Contributor> belongsToCollections, List<Contributor> belongsToSeries, Map<String, Object> otherMetadata)

Metadata

Metadata(String identifier, String type, Set<Publication.Profile> conformsTo, LocalizedString localizedTitle, LocalizedString localizedSubtitle, LocalizedString localizedSortAs, Instant modified, Instant published, Accessibility accessibility, List<String> languages, List<Subject> subjects, List<Contributor> authors, List<Contributor> translators, List<Contributor> editors, List<Contributor> artists, List<Contributor> illustrators, List<Contributor> letterers, List<Contributor> pencilers, List<Contributor> colorists, List<Contributor> inkers, List<Contributor> narrators, List<Contributor> contributors, List<Contributor> publishers, List<Contributor> imprints, ReadingProgression readingProgression, String description, Double duration, Integer numberOfPages, Map<String, List<Contributor>> belongsTo, Map<String, Object> otherMetadata)

Parameters:: otherMetadata - Additional metadata for extensions, as a JSON dictionary.

Method Detail

getTitle
```
 final String getTitle()
```

getSortAs
```
 final String getSortAs()
```

getBelongsToCollections

 final List<Contributor> getBelongsToCollections()

getBelongsToSeries

 final List<Contributor> getBelongsToSeries()

getLanguage
```
 final Language getLanguage()
```
Returns the Language resolved from the declared BCP 47 primary language.

getEffectiveReadingProgression

 final ReadingProgression getEffectiveReadingProgression()

getRdfType
```
 final String getRdfType()
```

getMultilanguageTitle

 final LocalizedString getMultilanguageTitle()

getDirection
```
 final String getDirection()
```

getPublicationDate
```
 final String getPublicationDate()
```

getRendition
```
 final Presentation getRendition()
```

getSource
```
 final String getSource()
```

getRights
```
 final String getRights()
```

getIdentifier
```
 final String getIdentifier()
```

getType
```
 final String getType()
```

getConformsTo

 final Set<Publication.Profile> getConformsTo()

getLocalizedTitle

 final LocalizedString getLocalizedTitle()

getLocalizedSubtitle

 final LocalizedString getLocalizedSubtitle()

getLocalizedSortAs

 final LocalizedString getLocalizedSortAs()

getModified
```
 final Instant getModified()
```

getPublished
```
 final Instant getPublished()
```

getAccessibility
```
 final Accessibility getAccessibility()
```

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

getSubjects
```
 final List<Subject> getSubjects()
```

getAuthors
```
 final List<Contributor> getAuthors()
```

getTranslators

 final List<Contributor> getTranslators()

getEditors
```
 final List<Contributor> getEditors()
```

getArtists
```
 final List<Contributor> getArtists()
```

getIllustrators

 final List<Contributor> getIllustrators()

getLetterers
```
 final List<Contributor> getLetterers()
```

getPencilers
```
 final List<Contributor> getPencilers()
```

getColorists
```
 final List<Contributor> getColorists()
```

getInkers
```
 final List<Contributor> getInkers()
```

getNarrators
```
 final List<Contributor> getNarrators()
```

getContributors

 final List<Contributor> getContributors()

getPublishers

 final List<Contributor> getPublishers()

getImprints
```
 final List<Contributor> getImprints()
```

getReadingProgression

 final ReadingProgression getReadingProgression()

getDescription
```
 final String getDescription()
```

getDuration
```
 final Double getDuration()
```

getNumberOfPages
```
 final Integer getNumberOfPages()
```

getBelongsTo

 final Map<String, List<Contributor>> getBelongsTo()

getOtherMetadata

 final Map<String, Object> getOtherMetadata()

toJSON
```
 JSONObject toJSON()
```
Serializes a Metadata to its RWPM JSON representation.

get
```
 final Object get(String key)
```
Syntactic sugar to access the otherMetadata values by subscripting Metadata directly. metadata["layout"] == metadata.otherMetadata["layout"]

titleForLang

@Deprecated(message = Use [localizedTitle.get] instead, replaceWith = @ReplaceWith(imports = {}, expression = localizedTitle.translationForLanguage(key)?.string), level = DeprecationLevel.ERROR) final String titleForLang(String key)

writeJSON

@Deprecated(message = Renamed into [toJSON], replaceWith = @ReplaceWith(imports = {}, expression = toJSON()), level = DeprecationLevel.ERROR) final JSONObject writeJSON()

Class Metadata

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.readium.r2.shared.publication.Metadata

Methods inherited from class java.lang.Object

Constructor Detail

Metadata

Metadata

Method Detail

getTitle

getSortAs

getBelongsToCollections

getBelongsToSeries

getLanguage

getEffectiveReadingProgression

getRdfType

getMultilanguageTitle

getDirection

getPublicationDate

getRendition

getSource

getRights

getIdentifier

getType

getConformsTo

getLocalizedTitle

getLocalizedSubtitle

getLocalizedSortAs

getModified

getPublished

getAccessibility

getLanguages

getSubjects

getAuthors

getTranslators

getEditors

getArtists

getIllustrators

getLetterers

getPencilers

getColorists

getInkers

getNarrators

getContributors

getPublishers

getImprints

getReadingProgression

getDescription

getDuration

getNumberOfPages

getBelongsTo

getOtherMetadata

toJSON

get

titleForLang

writeJSON