Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.aosh

Class CommandTable

java.lang.Object

com.aoindustries.aoserv.client.AOServTable<K,V>

com.aoindustries.aoserv.client.GlobalTable<String,V>

com.aoindustries.aoserv.client.GlobalTableStringKey<Command>

com.aoindustries.aoserv.client.aosh.CommandTable

All Implemented Interfaces:

Table<Command>, Iterable<Command>

public final class CommandTable
extends GlobalTableStringKey<Command>

Author:

AO Industries, Inc.

See Also:

Command

Nested Class Summary

Nested classes/interfaces inherited from class com.aoindustries.aoserv.client.AOServTable

AOServTable.OrderBy

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.AOServTable

ASCENDING, connector, DESCENDING

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears the cache, freeing up memory.
Command	get(String command)
List<Command>	getAOSHCommands(Table table)
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
List<Command>	getGlobalAOSHCommands()
Table.TableID	getTableID()	Gets the unique identifier for this table.
boolean	handleCommand(String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)

Methods inherited from class com.aoindustries.aoserv.client.GlobalTableStringKey

get

Methods inherited from class com.aoindustries.aoserv.client.GlobalTable

getGlobalRowCount, getIndexedRows, getRows, getRowsCopy, getUniqueRowImpl, isLoaded

Methods inherited from class com.aoindustries.aoserv.client.AOServTable

addProgressListener, addTableListener, addTableListener, addTableLoadListener, getCachedRowCount, getConnector, getDefaultOrderBySQLExpressions, getIndexedRows, getMap, getNewObject, getObject, getObjects, getObjects, getObjects, getObjectsNoProgress, getObjectsNoProgress, getSize, getSortAlgorithm, getTableName, getTableSchema, getUniqueRow, getUniqueRow, getUniqueRow, getUniqueRow, hasAnyTableListener, hasTableListener, isEmpty, iterator, printTable, removeProgressListener, removeTableListener, removeTableLoadListener, size, sortIfNeeded, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getDefaultOrderBy

protected AOServTable.OrderBy[] getDefaultOrderBy()

Description copied from class: AOServTable

Gets the default sorting for this table.

Specified by:

getDefaultOrderBy in class AOServTable<String,Command>

Returns:

null if the sorting is performed by the server or the array of column names

getAOSHCommands

public List<Command> getAOSHCommands(Table table)
                              throws IOException,
                                     SQLException

Throws:

IOException

SQLException

getGlobalAOSHCommands

public List<Command> getGlobalAOSHCommands()
                                    throws IOException,
                                           SQLException

Throws:

IOException

SQLException

getTableID

public Table.TableID getTableID()

Description copied from class: AOServTable

Gets the unique identifier for this table. Each table has a unique identifier, as defined in SchemaTable.TableID.

Specified by:

getTableID in class AOServTable<String,Command>

Returns:

the identifier for this table

See Also:

Table.TableID

handleCommand

public boolean handleCommand(String[] args,
                             Reader in,
                             TerminalWriter out,
                             TerminalWriter err,
                             boolean isInteractive)
                      throws IOException,
                             SQLException

Overrides:

handleCommand in class AOServTable<String,Command>

Throws:

IOException

SQLException

clearCache

public void clearCache()

Description copied from class: AOServTable

Clears the cache, freeing up memory. The data will be reloaded upon next use.

Overrides:

clearCache in class GlobalTable<String,Command>

get

public Command get(String command)
            throws IOException,
                   SQLException

Specified by:

get in class GlobalTableStringKey<Command>

Throws:

IOException

SQLException

See Also:

GlobalTableStringKey.get(java.lang.Object)