SortedTreeModel (OmniFaces 4.5 API)

java.lang.Object
- org.omnifaces.model.tree.AbstractTreeModel<T>
- - org.omnifaces.model.tree.SortedTreeModel<T>

Type Parameters:

T - The type of the wrapped data of the tree node.

All Implemented Interfaces:

Serializable, Comparable<T>, Iterable<TreeModel<T>>, TreeModel<T>
```
public class SortedTreeModel<T>
extends AbstractTreeModel<T>
implements Comparable<T>
```
A concrete implementation of TreeModel which holds the tree children in a TreeSet.

Since:

1.7

Author:

Bauke Scholtz

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

SortedTreeModel()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TreeModel<T>`	`addChild(T data)`	An override which throws `IllegalArgumentException` when given data is not `null` and not an instance of `Comparable`.
`int`	`compareTo(T object)`
`protected Collection<TreeModel<T>>`	`createChildren()`	Returns a new `TreeSet`.

Methods inherited from class org.omnifaces.model.tree.AbstractTreeModel
addChildNode, equals, getChildCount, getChildren, getData, getIndex, getLevel, getNextSibling, getParent, getPreviousSibling, hashCode, isFirst, isLast, isLeaf, isRoot, iterator, remove, setData, toString

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

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

- Constructor Detail
  - SortedTreeModel
```
public SortedTreeModel()
```
- Method Detail
  - createChildren
```
protected Collection<TreeModel<T>> createChildren()
```
    Returns a new TreeSet.
    
    Specified by:
    
    createChildren in class AbstractTreeModel<T>
    
    Returns:
    
    A concrete (and usually empty) Collection instance which should hold the tree's children.
  - addChild
```
public TreeModel<T> addChild(T data)
```
    An override which throws IllegalArgumentException when given data is not null and not an instance of Comparable. In other words, it only accepts null or an instance of Comparable.
    
    Specified by:
    
    addChild in interface TreeModel<T>
    
    Overrides:
    
    addChild in class AbstractTreeModel<T>
    
    Parameters:
    
    data - The wrapped data of the child tree node to be created and added.
    
    Returns:
    
    The newly created and added child tree node of the current tree node.
  - compareTo
```
public int compareTo(T object)
```
    Specified by:
    
    compareTo in interface Comparable<T>