Folder (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- i2p.susi.util.Folder<O>

Type Parameters:
O - type of objects stored in this folder
```
public class Folder<O>
extends Object
```
Manages an Object array with paging and sorting support. Create a folder, set contents with setElements(), add comparators with addSorter(), select a sort method with setSortBy(), and retrieve the current page with currentPageIterator(). All public methods are synchronized.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class Folder.SortOrder
Enumeration defining sort direction for folder elements.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Folder.SortOrder` Enumeration defining sort direction for folder elements.

Field Summary
Fields
Modifier and Type Field and Description
static int DEFAULT_PAGESIZE
Default page size for folder display
static String PAGESIZE
Property key for page size configuration

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PAGESIZE` Default page size for folder display
`static String`	`PAGESIZE` Property key for page size configuration

Constructor Summary
Constructors
Constructor and Description
Folder()
Default constructor

Constructors
Constructor and Description
`Folder()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addElement(O element)` Add an element only if it does not already exist.
`int`	`addElements(List<O> elems)` Add elements only if they do not already exist.
`void`	`addSorter(String id, Comparator<O> sorter)` Adds a new sorter to the folder.
`Iterator<O>`	`currentPageIterator()` Returns an iterator containing the elements on the current page.
`void`	`firstPage()` Sets folder to display first page.
`int`	`getCurrentPage()` Returns the current page number.
`String`	`getCurrentSortBy()` Get the ID of the current sort comparator.
`Folder.SortOrder`	`getCurrentSortingDirection()` Get the current sorting direction.
`O`	`getFirstElement()` Returns the first element of the sorted folder.
`O`	`getLastElement()` Returns the last element of the sorted folder.
`O`	`getNextElement(O element)` Retrieves the next element in the sorted array.
`int`	`getPageOf(O element)` Returns the page this element is on, using the current sort, or 1 if not found.
`int`	`getPages()` Returns the number of pages in the folder.
`int`	`getPageSize()` Returns page size.
`O`	`getPreviousElement(O element)` Retrieves the previous element in the sorted array.
`int`	`getSize()` Returns the number of elements in the folder.
`boolean`	`isFirstElement(O element)` Returns true if the element is the first in the sorted array.
`boolean`	`isFirstPage()` Returns true if the current page is the first page.
`boolean`	`isLastElement(O element)` Returns true if the element is the last in the sorted array.
`boolean`	`isLastPage()` Returns true if the current page is the last page.
`void`	`lastPage()` Sets folder to display last page.
`void`	`nextPage()` Turns folder to next page.
`void`	`previousPage()` Turns folder to previous page.
`void`	`removeElement(O element)` Remove an element from the folder.
`void`	`removeElements(Collection<O> elems)` Remove elements from the folder.
`void`	`setCurrentPage(int currentPage)` Set the current page number.
`void`	`setElements(O[] elements)` Set the array of objects the folder should manage.
`void`	`setPageSize(int pageSize)` Set page size and recalculate page counts.
`void`	`setSortBy(String id, Folder.SortOrder direction)` Activates sorting by the chosen Comparator.
`void`	`sort()` Sorts the elements according to the order given by `addSorter(String, Comparator)` and `setSortBy(String, SortOrder)`.

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

- Field Detail
  - DEFAULT_PAGESIZE
```
public static final int DEFAULT_PAGESIZE
```
    Default page size for folder display
    See Also:
    Constant Field Values
  - PAGESIZE
```
public static final String PAGESIZE
```
    Property key for page size configuration
    See Also:
    Constant Field Values
- Constructor Detail
  - Folder
```
public Folder()
```
    Default constructor
- Method Detail
  - addElement
```
public boolean addElement(O element)
```
    Add an element only if it does not already exist.
    Parameters:
    element - the element
    Returns:
    true if added
  - addElements
```
public int addElements(List<O> elems)
```
    Add elements only if they do not already exist. Re-sorts the array if a sorter is set and any elements are actually added.
    Parameters:
    elems - the list of elements to add
    Returns:
    number of elements added
  - addSorter
```
public void addSorter(String id,
                      Comparator<O> sorter)
```
    Adds a new sorter to the folder. You can sort the folder by calling setSortBy(String, SortOrder) with the given id.
    Parameters:
    id - identifier for this comparator, used with setSortBy(String, SortOrder)
    sorter - a Comparator to sort the elements
  - currentPageIterator
```
public Iterator<O> currentPageIterator()
```
    Returns an iterator containing the elements on the current page. This iterator is over a copy of the current page, and so is thread safe w.r.t. other operations on this folder, but will not reflect subsequent changes, and iter.remove() will not change the folder.
    Returns:
    Iterator containing the elements on the current page.
  - firstPage
```
public void firstPage()
```
    Sets folder to display first page.
  - getCurrentPage
```
public int getCurrentPage()
```
    Returns the current page number. Starts at 1, even if empty.
    Returns:
    the current page number
  - getCurrentSortBy
```
public String getCurrentSortBy()
```
    Get the ID of the current sort comparator.
    Returns:
    the current sort ID, or null if none
  - getCurrentSortingDirection
```
public Folder.SortOrder getCurrentSortingDirection()
```
    Get the current sorting direction.
    Returns:
    the current SortOrder (UP or DOWN)
  - getFirstElement
```
public O getFirstElement()
```
    Returns the first element of the sorted folder.
    Returns:
    First element.
  - getLastElement
```
public O getLastElement()
```
    Returns the last element of the sorted folder.
    Returns:
    Last element.
  - getNextElement
```
public O getNextElement(O element)
```
    Retrieves the next element in the sorted array.
    Parameters:
    element - the current element
    Returns:
    the next element, or null if this is the last
  - getPageOf
```
public int getPageOf(O element)
```
    Returns the page this element is on, using the current sort, or 1 if not found.
    Parameters:
    element - the element
    Returns:
    the page number (1-based)
  - getPages
```
public int getPages()
```
    Returns the number of pages in the folder. Minimum of 1 even if empty.
    Returns:
    the number of pages
  - getPageSize
```
public int getPageSize()
```
    Returns page size. If no page size has been set, returns the PAGESIZE property value, or DEFAULT_PAGESIZE.
    Returns:
    the page size
  - getPreviousElement
```
public O getPreviousElement(O element)
```
    Retrieves the previous element in the sorted array.
    Parameters:
    element - the current element
    Returns:
    the previous element, or null if this is the first
  - getSize
```
public int getSize()
```
    Returns the number of elements in the folder.
    Returns:
    the number of elements
  - isFirstElement
```
public boolean isFirstElement(O element)
```
    Returns true if the element is the first in the sorted array.
    Parameters:
    element - the element
    Returns:
    true if the element is the first
  - isFirstPage
```
public boolean isFirstPage()
```
    Returns true if the current page is the first page.
    Returns:
    true if on the first page
  - isLastElement
```
public boolean isLastElement(O element)
```
    Returns true if the element is the last in the sorted array.
    Parameters:
    element - the element
    Returns:
    true if the element is the last
  - isLastPage
```
public boolean isLastPage()
```
    Returns true if the current page is the last page.
    Returns:
    true if on the last page
  - lastPage
```
public void lastPage()
```
    Sets folder to display last page.
  - nextPage
```
public void nextPage()
```
    Turns folder to next page.
  - previousPage
```
public void previousPage()
```
    Turns folder to previous page.
  - removeElement
```
public void removeElement(O element)
```
    Remove an element from the folder.
    Parameters:
    element - the element
  - removeElements
```
public void removeElements(Collection<O> elems)
```
    Remove elements from the folder.
    Parameters:
    elems - the collection of elements to remove
  - setCurrentPage
```
public void setCurrentPage(int currentPage)
```
    Set the current page number. Starts at 1.
    Parameters:
    currentPage - the page number to set (1-based)
  - setElements
```
public void setElements(O[] elements)
```
    Set the array of objects the folder should manage. Does NOT copy the array. Sorts the array if a sorter set.
    Parameters:
    elements - Array of Os.
  - setPageSize
```
public void setPageSize(int pageSize)
```
    Set page size and recalculate page counts.
    Parameters:
    pageSize - the new page size
  - setSortBy
```
public void setSortBy(String id,
                      Folder.SortOrder direction)
```
    Activates sorting by the chosen Comparator. The id must match the one stored with addSorter(String, Comparator). Set the sorting direction of the folder. Warning: this does not do the actual sort, only addElements() and setElements() do.
    Parameters:
    id - identifier for the Comparator
    direction - UP or DOWN. UP is reverse sort.
  - sort
```
public void sort()
```
    Sorts the elements according to the order given by addSorter(String, Comparator) and setSortBy(String, SortOrder).

Class Folder<O>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PAGESIZE

PAGESIZE

Constructor Detail

Folder

Method Detail

addElement

addElements

addSorter

currentPageIterator

firstPage

getCurrentPage

getCurrentSortBy

getCurrentSortingDirection

getFirstElement

getLastElement

getNextElement

getPageOf

getPages

getPageSize

getPreviousElement

getSize

isFirstElement

isFirstPage

isLastElement

isLastPage

lastPage

nextPage

previousPage

removeElement

removeElements

setCurrentPage

setElements

setPageSize

setSortBy

sort