Package org.apache.pivot.wtk

Class TableView.SortDictionary

java.lang.Object

org.apache.pivot.wtk.TableView.SortDictionary

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>, Dictionary<java.lang.String,SortDirection>

Enclosing class:

TableView

public final class TableView.SortDictionary
extends java.lang.Object
implements Dictionary<java.lang.String,SortDirection>, java.lang.Iterable<java.lang.String>

Sort dictionary implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Dictionary

Dictionary.Pair<K,V>

Constructor Summary

Constructors

Constructor	Description
SortDictionary()

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(java.lang.String columnName)	Tests the existence of a key in the dictionary.
Dictionary.Pair<java.lang.String,SortDirection>	get(int index)
SortDirection	get(java.lang.String columnName)	Retrieves the value for the given key.
int	getLength()
boolean	isEmpty()
java.util.Iterator<java.lang.String>	iterator()
SortDirection	put(java.lang.String columnName, SortDirection sortDirection)	Sets the value of the given key, creating a new entry or replacing the existing value.
SortDirection	remove(java.lang.String columnName)	Removes a key/value pair from the map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.pivot.collections.Dictionary

containsAny, copy, getBoolean, getBoolean, getColor, getFirst, getFont, getInt, getInt, getString, getString, putAll

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SortDictionary

public SortDictionary()

Method Detail

get

public SortDirection get(java.lang.String columnName)

Description copied from interface: Dictionary

Retrieves the value for the given key.

Specified by:

get in interface Dictionary<java.lang.String,SortDirection>

Parameters:

columnName - The key whose value is to be returned.

Returns:

The value corresponding to key, or null if the key does not exist. Will also return null if the key refers to a null value. Use Dictionary.containsKey(K) to distinguish between these two cases.

put

public SortDirection put(java.lang.String columnName,
                         SortDirection sortDirection)

Description copied from interface: Dictionary

Sets the value of the given key, creating a new entry or replacing the existing value.

Specified by:

put in interface Dictionary<java.lang.String,SortDirection>

Parameters:

columnName - The key whose value is to be set.

sortDirection - The value to be associated with the given key.

Returns:

The value previously associated with the key.

remove

public SortDirection remove(java.lang.String columnName)

Description copied from interface: Dictionary

Removes a key/value pair from the map.

Specified by:

remove in interface Dictionary<java.lang.String,SortDirection>

Parameters:

columnName - The key whose mapping is to be removed.

Returns:

The value that was removed.

containsKey

public boolean containsKey(java.lang.String columnName)

Description copied from interface: Dictionary

Tests the existence of a key in the dictionary.

Specified by:

containsKey in interface Dictionary<java.lang.String,SortDirection>

Parameters:

columnName - The key whose presence in the dictionary is to be tested.

Returns:

true if the key exists in the dictionary; false, otherwise.

isEmpty

public boolean isEmpty()

get

public Dictionary.Pair<java.lang.String,SortDirection> get(int index)

getLength

public int getLength()

iterator

public java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>