MarkerReference (dotify.library 1.0.5 API)

java.lang.Object
- org.daisy.dotify.api.formatter.MarkerReference

Direct Known Subclasses:

MarkerReferenceField
```
public class MarkerReference
extends Object
```
A MarkerReference is a marker value lookup. The lookup is determined by the current position, possibly with an offset, by a scope and a direction.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MarkerReference.MarkerSearchDirection`	Defines marker search directions.
`static class`	`MarkerReference.MarkerSearchScope`	Defines marker search scopes.

Constructor Summary

Constructors
Constructor	Description
`MarkerReference(String markerName, MarkerReference.MarkerSearchDirection dir, MarkerReference.MarkerSearchScope scope, int offset)`	Creates a new instance with the specified parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`String`	`getName()`	Gets the name of this marker reference.
`int`	`getOffset()`	Gets the page offset where to start the search.
`MarkerReference.MarkerSearchDirection`	`getSearchDirection()`	Gets the direction of the search.
`MarkerReference.MarkerSearchScope`	`getSearchScope()`	Gets the scope of the search.
`int`	`hashCode()`

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

- Constructor Detail
  - MarkerReference
```
public MarkerReference(String markerName,
                       MarkerReference.MarkerSearchDirection dir,
                       MarkerReference.MarkerSearchScope scope,
                       int offset)
```
    Creates a new instance with the specified parameters.
    
    Parameters:
    
    markerName - the name of the marker
    
    dir - the direction
    
    scope - the scope
    
    offset - offsets the search by the specified amount, in pages
- Method Detail
  - getName
```
public String getName()
```
    Gets the name of this marker reference.
    
    Returns:
    
    returns the name
  - getSearchDirection
```
public MarkerReference.MarkerSearchDirection getSearchDirection()
```
    Gets the direction of the search.
    
    Returns:
    
    returns the search direction
  - getSearchScope
```
public MarkerReference.MarkerSearchScope getSearchScope()
```
    Gets the scope of the search.
    
    Returns:
    
    returns the search scope
  - getOffset
```
public int getOffset()
```
    Gets the page offset where to start the search.
    
    Returns:
    
    the page offset
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object