All Implemented Interfaces:

android.os.Parcelable , org.readium.r2.shared.JSONable
```
public final class Locator
 implements JSONable, Parcelable
                    
```
Represents a precise location in a publication in a format that can be stored and shared.
There are many different use cases for locators:
- getting back to the last position in a publication
- bookmarks
- highlights & annotations
- search results
- human-readable (and shareable) reference in a publication
https://readium.org/architecture/models/locators/

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Locator.Locations`	One or more alternative expressions of the location. https://github.com/readium/architecture/tree/master/models/locators#the-location-object
`public final class`	`Locator.Text`	Textual context of the locator. A Locator Text Object contains multiple text fragments, useful to give a context to the Locator or for highlights. https://github.com/readium/architecture/tree/master/models/locators#the-text-object
`public class`	`Locator.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`type`
`private final Url`	`href`
`private final MediaType`	`mediaType`
`private final String`	`title`
`private final Locator.Locations`	`locations`
`private final Locator.Text`	`text`

Constructor Summary

Constructors
Constructor	Description
`Locator(String href, String type, String title, Locator.Locations locations, Locator.Text text)`
`Locator(Url href, MediaType mediaType, String title, Locator.Locations locations, Locator.Text text)`

Method Summary

Modifier and Type	Method	Description
`final String`	`getType()`
`final Url`	`getHref()`
`final MediaType`	`getMediaType()`
`final String`	`getTitle()`
`final Locator.Locations`	`getLocations()`
`final Locator.Text`	`getText()`
`final Locator`	`copyWithLocations(List<String> fragments, Double progression, Integer position, Double totalProgression, Map<String, Object> otherLocations)`	Shortcut to get a copy of the Locator with different Locations sub-properties.
`JSONObject`	`toJSON()`	Serializes the object to its JSON representation.

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

Constructor Detail

Locator

Locator(String href, String type, String title, Locator.Locations locations, Locator.Text text)

Locator

Locator(Url href, MediaType mediaType, String title, Locator.Locations locations, Locator.Text text)

Method Detail

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

getHref
```
 final Url getHref()
```

getMediaType
```
 final MediaType getMediaType()
```

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

getLocations
```
 final Locator.Locations getLocations()
```

getText
```
 final Locator.Text getText()
```

copyWithLocations

 final Locator copyWithLocations(List<String> fragments, Double progression, Integer position, Double totalProgression, Map<String, Object> otherLocations)

Shortcut to get a copy of the Locator with different Locations sub-properties.

toJSON
```
 JSONObject toJSON()
```
Serializes the object to its JSON representation.

Class Locator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Locator

Locator

Method Detail

getType

getHref

getMediaType

getTitle

getLocations

getText

copyWithLocations

toJSON