PageSet (FitLayout Core 2.0.1 API)

All Superinterfaces:

Iterable<Page>

All Known Implementing Classes:

AbstractPageSet
```
public interface PageSet
extends Iterable<Page>
```
A named set of pages processed together.

Author:

burgetr

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addPage(Page page)`	Adds a new page to the set.
`Page`	`get(int index)`	Obtains the page at the given index.
`Date`	`getDateCreated()`	Obtains the creation date of the set.
`String`	`getDescription()`	Obtains the set description.
`String`	`getName()`	Obtains the name of the set.
`int`	`size()`	Obtains the number of pages contained in this set.

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - getName
```
String getName()
```
    Obtains the name of the set.
    
    Returns:
    
    the set name
  - getDescription
```
String getDescription()
```
    Obtains the set description.
    
    Returns:
    
    the description (possibly empty)
  - getDateCreated
```
Date getDateCreated()
```
    Obtains the creation date of the set.
    
    Returns:
    
    the date
  - size
```
int size()
```
    Obtains the number of pages contained in this set.
    
    Returns:
    
    the page number
  - addPage
```
void addPage(Page page)
```
    Adds a new page to the set.
    
    Parameters:
    
    page - The page to be added.
  - get
```
Page get(int index)
  throws IndexOutOfBoundsException
```
    Obtains the page at the given index.
    
    Parameters:
    
    index -
    
    Returns:
    
    Throws:
    
    IndexOutOfBoundsException