org.apache.ignite.internal.commandline.meta

Class MetadataCommand

java.lang.Object

org.apache.ignite.internal.commandline.meta.MetadataCommand

All Implemented Interfaces:

Command<Object>

public class MetadataCommand
extends Object
implements Command<Object>

Constructor Summary

Constructors

Constructor and Description
MetadataCommand()

Method Summary

Modifier and Type	Method and Description
Object	arg()
String	confirmationPrompt()
Object	execute(GridClientConfiguration clientCfg, Logger log) Actual command execution.
boolean	experimental() Return true if the command is experimental or false otherwise.
String	name()
void	parseArguments(CommandArgIterator argIter) Parse command-specific arguments.
void	printUsage(Logger log) Print info for user about command (parameters, use cases and so on).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.internal.commandline.Command

experimentalEnabled, extendToLen, prepareConfirmation, startClient, usage, usage, usageParams

Constructor Detail

MetadataCommand

public MetadataCommand()

Method Detail

printUsage

public void printUsage(Logger log)

Print info for user about command (parameters, use cases and so on).

Specified by:

printUsage in interface Command<Object>

Parameters:

log - Logger to use.

name

public String name()

Specified by:

name in interface Command<Object>

Returns:

command name.

parseArguments

public void parseArguments(CommandArgIterator argIter)

Parse command-specific arguments.

Specified by:

parseArguments in interface Command<Object>

Parameters:

argIter - Argument iterator.

experimental

public boolean experimental()

Return true if the command is experimental or false otherwise.

Specified by:

experimental in interface Command<Object>

Returns:

true if the command is experimental or false otherwise.

confirmationPrompt

public String confirmationPrompt()

Specified by:

confirmationPrompt in interface Command<Object>

Returns:

Message text to show user for. If null it means that confirmantion is not needed.

execute

public Object execute(GridClientConfiguration clientCfg,
                      Logger log)
               throws Exception

Actual command execution. Parameters for run should be already set by calling parseArguments method.

Specified by:

execute in interface Command<Object>

Parameters:

clientCfg - Thin client configuration if connection to cluster is necessary.

log - Logger to use.

Returns:

Result of operation (mostly usable for tests).

Throws:

Exception - If error occur.

arg

public Object arg()

Specified by:

arg in interface Command<Object>

Returns:

Command arguments which were parsed during Command.parseArguments(CommandArgIterator) call.