DocumentSpace (dotify.library 1.0.5 API)

java.lang.Object
- org.daisy.dotify.formatter.impl.search.DocumentSpace

```
public final class DocumentSpace
extends Object
```
Provides coordinates for a coherent document space. Each volume consists of three coordinates representing three distinct search spaces where markers can be found in the largest scope (called "document"). In other words, a search for markers cannot retrieve something outside of the search's document space coordinates.

For this reason, the whole of the main text flow is in the same document space, that is to say it is not qualified with a volume number.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  DocumentSpace(Space space, Integer volumeNumber)
  Note that Space.BODY ignores volumeNumber.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean equals(Object obj)
  
  int hashCode()
  
  String toString()
  - Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentSpace
```
public DocumentSpace(Space space,
                     Integer volumeNumber)
```
    Note that Space.BODY ignores volumeNumber.
    
    Parameters:
    
    space - the space
    
    volumeNumber - the volume number
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object