pl.edu.agh.age.console.command

Interface Command

All Known Implementing Classes:

ClearScreenCommand, ClusterCommand, ComputationCommand, HelpCommand, LoggingCommand, TestCommand, TopologyCommand

public interface Command

Interface for commands used by the pl.edu.agh.age.console.

Method Summary

Modifier and Type	Method and Description
static <T> T	checkAndCast(java.lang.Object obj, java.lang.Class<T> klass, java.lang.String msg) Checks if the object is of given klass, and if not, throws an exception
static <T,V extends T> T	checkAndCastDefault(@Nullable java.lang.Object obj, java.lang.Class<T> klass, V def, java.lang.String msg) Checks if the object is of given klass, and if not, throws an exception
static <T> java.util.Optional<T>	checkAndCastNullable(@Nullable java.lang.Object obj, java.lang.Class<T> klass, java.lang.String msg) Checks if the object is of given klass, and if not, throws an exception
static <T> T	getAndCast(java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String name, java.lang.Class<T> klass) Returns the named object from the map only if the object is of given klass, and if not, throws an exception
static <T,V extends T> T	getAndCastDefault(java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String name, java.lang.Class<T> klass, V def) Returns the named object from the map only if the object is of given klass, and if not, throws an exception
static <T> java.util.Optional<T>	getAndCastNullable(java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String name, java.lang.Class<T> klass) Returns the named object from the map only if the object is of given klass, and if not, throws an exception
java.lang.String	name() Name of the command (for JavaScript side)

Method Detail

name

java.lang.String name()

Name of the command (for JavaScript side)

checkAndCast

static <T> T checkAndCast(java.lang.Object obj,
                          java.lang.Class<T> klass,
                          java.lang.String msg)

Checks if the object is of given klass, and if not, throws an exception

This version requires obj to be nonnull.

Type Parameters:

T - expected type of the object

Parameters:

obj - an object to check

klass - expected class

msg - message for the exception

Returns:

the obj cast to klass, if not possible - throws an exception

Throws:

java.lang.IllegalArgumentException - when obj is not instance of klass. msg is used as a message string

getAndCast

static <T> T getAndCast(java.util.Map<java.lang.String,java.lang.Object> parameters,
                        java.lang.String name,
                        java.lang.Class<T> klass)

Returns the named object from the map only if the object is of given klass, and if not, throws an exception

This version requires name to point to a nonnull object.

Type Parameters:

T - expected type of the object

Parameters:

parameters - name -> object mapping

name - name of the parameter to get

klass - expected class

Returns:

the name object from parameters map cast to klass, if not possible - throws an exception

Throws:

java.lang.IllegalArgumentException - when obj the object is not instance of klass. msg is used as a message string

See Also:

checkAndCast(Object, Class, String)

checkAndCastNullable

static <T> java.util.Optional<T> checkAndCastNullable(@Nullable java.lang.Object obj,
                                                      java.lang.Class<T> klass,
                                                      java.lang.String msg)

Checks if the object is of given klass, and if not, throws an exception

This version accepts null and returns empty Optional in such a case.

Type Parameters:

T - expected type of the object

Parameters:

obj - an object to check

klass - expected class

msg - message for the exception

Returns:

the obj cast to klass, if not possible - throws an exception

Throws:

java.lang.IllegalArgumentException - when obj is not instance of klass. msg is used as a message string

getAndCastNullable

static <T> java.util.Optional<T> getAndCastNullable(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                    java.lang.String name,
                                                    java.lang.Class<T> klass)

Returns the named object from the map only if the object is of given klass, and if not, throws an exception

This version accepts name pointing to a null object.

Type Parameters:

T - expected type of the object

Parameters:

parameters - name -> object mapping

name - name of the parameter to get

klass - expected class

Returns:

the name object from parameters map cast to klass, if not possible - throws an exception

Throws:

java.lang.IllegalArgumentException - when obj the object is not instance of klass. msg is used as a message string

See Also:

checkAndCastNullable(Object, Class, String)

checkAndCastDefault

static <T,V extends T> T checkAndCastDefault(@Nullable java.lang.Object obj,
                                             java.lang.Class<T> klass,
                                             V def,
                                             java.lang.String msg)

Checks if the object is of given klass, and if not, throws an exception

This version accepts null and returns the provided default value.

Type Parameters:

T - expected type of the object

Parameters:

obj - an object to check

klass - expected class

def - default value to return

msg - message for the exception

Returns:

the obj cast to klass or def, if not possible - throws an exception

Throws:

java.lang.IllegalArgumentException - when obj is not instance of klass. msg is used as a message string

getAndCastDefault

static <T,V extends T> T getAndCastDefault(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                           java.lang.String name,
                                           java.lang.Class<T> klass,
                                           V def)

Returns the named object from the map only if the object is of given klass, and if not, throws an exception

This version accepts name pointing to a null object.

Type Parameters:

T - expected type of the object

Parameters:

parameters - name -> object mapping

name - name of the parameter to get

klass - expected class

def - default value to return

Returns:

the name object from parameters map cast to klass, if not possible - throws an exception

Throws:

java.lang.IllegalArgumentException - when obj the object is not instance of klass. msg is used as a message string

See Also:

checkAndCastDefault(Object, Class, Object, String)