Package org.apache.ignite.internal.management.cache

Class CacheListCommand

java.lang.Object

org.apache.ignite.internal.management.cache.CacheListCommand

All Implemented Interfaces:

Command<CacheListCommandArg,ViewCacheTaskResult>, LocalCommand<CacheListCommandArg,ViewCacheTaskResult>

public class CacheListCommand
extends Object
implements LocalCommand<CacheListCommandArg,ViewCacheTaskResult>

Prints info regarding caches, groups or sequences.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CacheListCommand.OutputFormat

Field Summary

Fields inherited from interface org.apache.ignite.internal.management.api.Command

CMD_NAME_POSTFIX

Constructor Summary

Constructors

Constructor	Description
CacheListCommand()

Method Summary

Modifier and Type	Method	Description
Class<CacheListCommandArg>	argClass()
String	description()	Command description.
ViewCacheTaskResult	execute(@Nullable GridClient cli, @Nullable IgniteClient client, @Nullable Ignite ignite, CacheListCommandArg arg, Consumer<String> printer)	Executes command logic.

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.management.api.Command

confirmationPrompt, deprecationMessage

Constructor Detail

CacheListCommand

public CacheListCommand()

Method Detail

description

public String description()

Command description.

Specified by:

description in interface Command<CacheListCommandArg,ViewCacheTaskResult>

argClass

public Class<CacheListCommandArg> argClass()

Specified by:

argClass in interface Command<CacheListCommandArg,ViewCacheTaskResult>

Returns:

Arguments class.

execute

public ViewCacheTaskResult execute(@Nullable
                                   @Nullable GridClient cli,
                                   @Nullable
                                   @Nullable IgniteClient client,
                                   @Nullable
                                   @Nullable Ignite ignite,
                                   CacheListCommandArg arg,
                                   Consumer<String> printer)
                            throws Exception

Executes command logic. Commands invoked in two different environments:

• CLI utility using GridClient connection to interact with cluster.
• Inside Ignite node therefore local node can be used to interact with cluster.

Please, keep in mind that GridClient protocol is obsolete and can be removed in future releases.

Specified by:

execute in interface LocalCommand<CacheListCommandArg,ViewCacheTaskResult>

Parameters:

cli - Optional grid client instance.

ignite - Optional ignite node.

arg - Command argument.

printer - Results printer.

Returns:

Command result.

Throws:

Exception