#include <berryParameterizedCommand.h>

Inheritance diagram for berry::ParameterizedCommand:

Collaboration diagram for berry::ParameterizedCommand:

Public Member Functions
	berryObjectMacro (ParameterizedCommand)

	ParameterizedCommand (const SmartPointer< Command > &command, const QList< Parameterization > &parameterizations)

bool	operator< (const Object *object) const override

bool	operator== (const Object *object) const override

Object::Pointer	ExecuteWithChecks (const Object::ConstPointer &trigger, const Object::Pointer &applicationContext)

SmartPointer< Command >	GetCommand () const

QString	GetId () const

QString	GetName () const

QHash< QString, QString >	GetParameterMap () const

uint	HashCode () const override

QString	Serialize ()

QString	ToString () const override

Public Member Functions inherited from berry::Object
virtual QString	GetClassName () const

virtual Reflection::TypeInfo	GetTypeInfo () const

virtual QList< Reflection::TypeInfo >	GetSuperclasses () const

virtual void	Delete ()

QDebug	Print (QDebug os, Indent Indent=0) const

void	Register () const

void	UnRegister (bool del=true) const

int	GetReferenceCount () const

void	SetReferenceCount (int)

void	AddDestroyListener (const MessageAbstractDelegate<> &delegate) const

void	RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const

Static Public Member Functions
static QList< ParameterizedCommand::Pointer >	GenerateCombinations (const SmartPointer< Command > command)

static ParameterizedCommand::Pointer	GenerateCommand (const SmartPointer< Command > command, const QHash< QString, Object::Pointer > &parameters)

Static Public Member Functions inherited from berry::Object
static const char *	GetStaticClassName ()

static Reflection::TypeInfo	GetStaticTypeInfo ()

static QList< Reflection::TypeInfo >	GetStaticSuperclasses ()

Static Public Attributes
static const int	INDEX_PARAMETER_ID

static const int	INDEX_PARAMETER_NAME

static const int	INDEX_PARAMETER_VALUE_NAME

static const int	INDEX_PARAMETER_VALUE_VALUE

Additional Inherited Members
Public Types inherited from berry::Object
typedef Object	Self

typedef berry::SmartPointer< Self >	Pointer

typedef berry::SmartPointer< const Self >	ConstPointer

typedef berry::WeakPointer< Self >	WeakPtr

typedef berry::WeakPointer< const Self >	ConstWeakPtr

Protected Member Functions inherited from berry::Object
	Object ()

virtual	~Object ()

virtual QDebug	PrintSelf (QDebug os, Indent indent) const

virtual QDebug	PrintHeader (QDebug os, Indent indent) const

virtual QDebug	PrintTrailer (QDebug os, Indent indent) const

Protected Attributes inherited from berry::Object
QAtomicInt	m_ReferenceCount

QMutex	m_ReferenceCountLock

Detailed Description

A command that has had one or more of its parameters specified. This class serves as a utility class for developers that need to manipulate commands with parameters. It handles the behaviour of generating a parameter map and a human-readable name.

Definition at line 40 of file berryParameterizedCommand.h.

Constructor & Destructor Documentation

◆ ParameterizedCommand()

berry::ParameterizedCommand::ParameterizedCommand	(	const SmartPointer< Command > &	command,
		const QList< Parameterization > &	parameterizations
	)

Constructs a new instance of ParameterizedCommand with specific values for zero or more of its parameters.

Parameters

command	The command that is parameterized; must not be `null`.
parameterizations	An array of parameterizations binding parameters to values for the command. This value may be `null`.

Definition at line 37 of file berryParameterizedCommand.cpp.

Referenced by GenerateCombinations(), and GenerateCommand().

Member Function Documentation

◆ berryObjectMacro()

berry::ParameterizedCommand::berryObjectMacro ( ParameterizedCommand )

◆ ExecuteWithChecks()

Object::Pointer berry::ParameterizedCommand::ExecuteWithChecks	(	const Object::ConstPointer &	trigger,
		const Object::Pointer &	applicationContext
	)

Executes this command with its parameters. This does extra checking to see if the command is enabled and defined. If it is not both enabled and defined, then the execution listeners will be notified and an exception thrown.

Parameters

trigger	The object that triggered the execution; may be `null`.
applicationContext	The state of the application at the time the execution was triggered; may be `null`.

Returns: The result of the execution; may be null.

Exceptions

ExecutionException	If the handler has problems executing this command.
NotDefinedException	If the command you are trying to execute is not defined.
NotEnabledException	If the command you are trying to execute is not enabled.
NotHandledException	If there is no handler.

Definition at line 116 of file berryParameterizedCommand.cpp.

References GetParameterMap().

◆ GenerateCombinations()

QList< ParameterizedCommand::Pointer > berry::ParameterizedCommand::GenerateCombinations ( const SmartPointer< Command > command )

static

Generates all the possible combinations of command parameterizations for the given command. If the command has no parameters, then this is simply a parameterized version of that command. If a parameter is optional, both the included and not included cases are considered.

If one of the parameters cannot be loaded due to a ParameterValuesException, then it is simply ignored.

Parameters

command The command for which the parameter combinations should be generated; must not be null.

Returns: A collection of ParameterizedCommand instances representing all of the possible combinations. This value is never empty and it is never null.

Exceptions

NotDefinedException If the command is not defined.

Definition at line 252 of file berryParameterizedCommand.cpp.

References ParameterizedCommand().

◆ GenerateCommand()

ParameterizedCommand::Pointer berry::ParameterizedCommand::GenerateCommand	(	const SmartPointer< Command >	command,
		const QHash< QString, Object::Pointer > &	parameters
	)

static

Take a command and a map of parameter IDs to values, and generate the appropriate parameterized command.

Parameters

command	The command object. Must not be `null`.
parameters	A map of String parameter ids to objects. May be `null`.

Returns: the parameterized command, or null if it could not be generated

Definition at line 274 of file berryParameterizedCommand.cpp.

References berry::CommandManager::ESCAPE_CHAR, berry::IParameterValues::GetParameterValues(), berry::CommandManager::ID_VALUE_CHAR, berry::CommandManager::PARAMETER_END_CHAR, berry::CommandManager::PARAMETER_SEPARATOR_CHAR, berry::CommandManager::PARAMETER_START_CHAR, and ParameterizedCommand().

Referenced by berry::CommandContributionItem::UpdateCommandPropertiesInUI().

◆ GetCommand()

SmartPointer< Command > berry::ParameterizedCommand::GetCommand ( ) const

Returns the base command. It is possible for more than one parameterized command to have the same identifier.

Returns: The command; never null, but may be undefined.

Definition at line 124 of file berryParameterizedCommand.cpp.

◆ GetId()

QString berry::ParameterizedCommand::GetId ( ) const

Returns the command's base identifier. It is possible for more than one parameterized command to have the same identifier.

Returns: The command id; never null.

Definition at line 129 of file berryParameterizedCommand.cpp.

Referenced by operator<(), and Serialize().

◆ GetName()

QString berry::ParameterizedCommand::GetName ( ) const

Returns a human-readable representation of this command with all of its parameterizations.

Returns: The human-readable representation of this parameterized command; never null.

Exceptions

NotDefinedException If the underlying command is not defined.

Definition at line 134 of file berryParameterizedCommand.cpp.

References berry::Parameterization::GetParameter(), and berry::Parameterization::GetValueName().

Referenced by operator<().

◆ GetParameterMap()

QHash< QString, QString > berry::ParameterizedCommand::GetParameterMap ( ) const

Returns the parameter map, as can be used to construct an ExecutionEvent.

Returns: The map of parameter ids (String) to parameter values (String). This map is never null, but may be empty.

Definition at line 169 of file berryParameterizedCommand.cpp.

References berry::Parameterization::GetParameter(), and berry::Parameterization::GetValue().

Referenced by ExecuteWithChecks().

◆ HashCode()

uint berry::ParameterizedCommand::HashCode ( ) const

overridevirtual

Returns a hash code value for the object.

Reimplemented from berry::Object.

Definition at line 181 of file berryParameterizedCommand.cpp.

◆ operator<()

bool berry::ParameterizedCommand::operator< ( const Object * o ) const

overridevirtual

Override this method to implement a specific "less than" operator for associative STL containers.

Reimplemented from berry::Object.

Definition at line 70 of file berryParameterizedCommand.cpp.

References GetId(), and GetName().

◆ operator==()

bool berry::ParameterizedCommand::operator== ( const Object * o ) const

overridevirtual

A generic comparison method. Override this method in subclasses and cast to your derived class to provide a more detailed comparison.

Reimplemented from berry::Object.

Definition at line 96 of file berryParameterizedCommand.cpp.

◆ Serialize()

QString berry::ParameterizedCommand::Serialize ( )

Returns a String containing the command id, parameter ids and parameter values for this ParameterizedCommand. The returned String can be stored by a client and later used to reconstruct an equivalent ParameterizedCommand using the CommandManager#deserialize(String) method.

The syntax of the returned String is as follows:

serialization = commandId [ '(' parameters ')' ]
parameters = parameter [ ',' parameters ]
parameter = parameterId [ '=' parameterValue ]

In the syntax above, sections inside square-brackets are optional. The characters in single quotes ((, ), , and =) indicate literal characters.

commandId represents the command id encoded with separator characters escaped. parameterId and parameterValue represent the parameter ids and values encoded with separator characters escaped. The separator characters (, ), , and = are escaped by prepending a %. This requires % to be escaped, which is also done by prepending a %.

The order of the parameters is not defined (and not important). A missing parameterValue indicates that the value of the parameter is null.

For example, the string shown below represents a serialized parameterized command that can be used to show the Resource perspective:

org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.ui.resourcePerspective)

This example shows the more general form with multiple parameters, null value parameters, and escaped = in the third parameter value.

command.id(param1.id=value1,param2.id,param3.id=esc%=val3)

Returns: A string containing the escaped command id, parameter ids and parameter values; never null.

See also: CommandManager::deserialize(String)

Definition at line 200 of file berryParameterizedCommand.cpp.

References GetId(), berry::Parameterization::GetParameter(), berry::Parameterization::GetValue(), berry::CommandManager::ID_VALUE_CHAR, berry::CommandManager::PARAMETER_END_CHAR, berry::CommandManager::PARAMETER_SEPARATOR_CHAR, and berry::CommandManager::PARAMETER_START_CHAR.

◆ ToString()

QString berry::ParameterizedCommand::ToString ( ) const

overridevirtual

Returns a string representation of this object. The default implementation returns an empty string.

Reimplemented from berry::Object.

Definition at line 242 of file berryParameterizedCommand.cpp.

Member Data Documentation

◆ INDEX_PARAMETER_ID

const int berry::ParameterizedCommand::INDEX_PARAMETER_ID

static

The index of the parameter id in the parameter values.

Deprecated:: no longer used

Definition at line 52 of file berryParameterizedCommand.h.

◆ INDEX_PARAMETER_NAME

const int berry::ParameterizedCommand::INDEX_PARAMETER_NAME

static

The index of the human-readable name of the parameter itself, in the parameter values.

Deprecated:: no longer used

Definition at line 60 of file berryParameterizedCommand.h.

◆ INDEX_PARAMETER_VALUE_NAME

const int berry::ParameterizedCommand::INDEX_PARAMETER_VALUE_NAME

static

The index of the human-readable name of the value of the parameter for this command.

Deprecated:: no longer used

Definition at line 68 of file berryParameterizedCommand.h.

◆ INDEX_PARAMETER_VALUE_VALUE

const int berry::ParameterizedCommand::INDEX_PARAMETER_VALUE_VALUE

static

The index of the value of the parameter that the command can understand.

Deprecated:: no longer used

Definition at line 75 of file berryParameterizedCommand.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParameterizedCommand()

Member Function Documentation

◆ berryObjectMacro()

◆ ExecuteWithChecks()

◆ GenerateCombinations()

◆ GenerateCommand()

◆ GetCommand()

◆ GetId()

◆ GetName()

◆ GetParameterMap()

◆ HashCode()

◆ operator<()

◆ operator==()

◆ Serialize()

◆ ToString()

Member Data Documentation

◆ INDEX_PARAMETER_ID

◆ INDEX_PARAMETER_NAME

◆ INDEX_PARAMETER_VALUE_NAME

◆ INDEX_PARAMETER_VALUE_VALUE