VolumeData (dotify.library 1.0.5 API)

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

```
public final class VolumeData
extends Object
```
Provides basic volume data for identifiers.

Identifiers are used to mark data in the content so that it is possible to refer to the place in the content where the identifier occurs after the document has been processed. This class lists the volume related properties of identifiers that we need elsewhere in the code.

Constructor Summary

Constructors
Constructor Description

VolumeData(int volumeNumber, boolean atStartOfVolumeContents)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`int`	`getVolumeNumber()`	Get the volume number where an identifier is placed in the content.
`int`	`hashCode()`
`boolean`	`isAtStartOfVolumeContents()`	Indicates whether an identifier is placed at the start of the volume contents.
`String`	`toString()`

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

- Constructor Detail
  - VolumeData
```
public VolumeData(int volumeNumber,
                  boolean atStartOfVolumeContents)
```
- Method Detail
  - getVolumeNumber
```
public int getVolumeNumber()
```
    Get the volume number where an identifier is placed in the content.
    
    Returns:
    
    the volume number
  - isAtStartOfVolumeContents
```
public boolean isAtStartOfVolumeContents()
```
    Indicates whether an identifier is placed at the start of the volume contents. This information is used in the processing of toc-entry-on-resumed elements.
    
    Returns:
    
    whether the location of an identifier is at the start of the volume contents
  - 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