Package org.eclipse.core.commands
Class CommandManagerEvent
- java.lang.Object
-
- org.eclipse.core.commands.CommandManagerEvent
-
public final class CommandManagerEvent extends Object
An event indicating that the set of defined command identifiers has changed.
- Since:
- 3.1
- See Also:
ICommandManagerListener.commandManagerChanged(CommandManagerEvent)
-
-
Constructor Summary
Constructors Constructor Description CommandManagerEvent(CommandManager commandManager, String parameterTypeId, boolean parameterTypeIdAdded, boolean parameterTypeIdChanged)Creates a newCommandManagerEventinstance to describe changes to command parameter types.CommandManagerEvent(CommandManager commandManager, String commandId, boolean commandIdAdded, boolean commandIdChanged, String categoryId, boolean categoryIdAdded, boolean categoryIdChanged)Creates a newCommandManagerEventinstance to describe changes to commands and/or categories.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetCategoryId()Returns the category identifier that was added or removed.StringgetCommandId()Returns the command identifier that was added or removed.CommandManagergetCommandManager()Returns the instance of the interface that changed.StringgetParameterTypeId()Returns the command parameter type identifier that was added or removed.booleanisCategoryChanged()Returns whether the list of defined category identifiers has changed.booleanisCategoryDefined()Returns whether the category identifier became defined.booleanisCommandChanged()Returns whether the list of defined command identifiers has changed.booleanisCommandDefined()Returns whether the command identifier became defined.booleanisParameterTypeChanged()Returns whether the list of defined command parameter type identifiers has changed.booleanisParameterTypeDefined()Returns whether the command parameter type identifier became defined.
-
-
-
Constructor Detail
-
CommandManagerEvent
public CommandManagerEvent(CommandManager commandManager, String commandId, boolean commandIdAdded, boolean commandIdChanged, String categoryId, boolean categoryIdAdded, boolean categoryIdChanged)
Creates a newCommandManagerEventinstance to describe changes to commands and/or categories.- Parameters:
commandManager- the instance of the interface that changed; must not benull.commandId- The command identifier that was added or removed; must not benullif commandIdChanged istrue.commandIdAdded- Whether the command identifier became defined (otherwise, it became undefined).commandIdChanged- Whether the list of defined command identifiers has changed.categoryId- The category identifier that was added or removed; must not benullif categoryIdChanged istrue.categoryIdAdded- Whether the category identifier became defined (otherwise, it became undefined).categoryIdChanged- Whether the list of defined category identifiers has changed.
-
CommandManagerEvent
public CommandManagerEvent(CommandManager commandManager, String parameterTypeId, boolean parameterTypeIdAdded, boolean parameterTypeIdChanged)
Creates a newCommandManagerEventinstance to describe changes to command parameter types.- Parameters:
commandManager- the instance of the interface that changed; must not benull.parameterTypeId- The command parameter type identifier that was added or removed; must not benullif parameterTypeIdChanged istrue.parameterTypeIdAdded- Whether the parameter type identifier became defined (otherwise, it became undefined).parameterTypeIdChanged- Whether the list of defined parameter type identifiers has changed.- Since:
- 3.2
-
-
Method Detail
-
getCategoryId
public final String getCategoryId()
Returns the category identifier that was added or removed.- Returns:
- The category identifier that was added or removed; may be
null.
-
getCommandId
public final String getCommandId()
Returns the command identifier that was added or removed.- Returns:
- The command identifier that was added or removed; may be
null.
-
getCommandManager
public final CommandManager getCommandManager()
Returns the instance of the interface that changed.- Returns:
- the instance of the interface that changed. Guaranteed not to be
null.
-
getParameterTypeId
public final String getParameterTypeId()
Returns the command parameter type identifier that was added or removed.- Returns:
- The command parameter type identifier that was added or removed;
may be
null. - Since:
- 3.2
-
isCategoryChanged
public final boolean isCategoryChanged()
Returns whether the list of defined category identifiers has changed.- Returns:
trueif the list of category identifiers has changed;falseotherwise.
-
isCategoryDefined
public final boolean isCategoryDefined()
Returns whether the category identifier became defined. Otherwise, the category identifier became undefined.- Returns:
trueif the category identifier became defined;falseif the category identifier became undefined.
-
isCommandChanged
public final boolean isCommandChanged()
Returns whether the list of defined command identifiers has changed.- Returns:
trueif the list of command identifiers has changed;falseotherwise.
-
isCommandDefined
public final boolean isCommandDefined()
Returns whether the command identifier became defined. Otherwise, the command identifier became undefined.- Returns:
trueif the command identifier became defined;falseif the command identifier became undefined.
-
isParameterTypeChanged
public final boolean isParameterTypeChanged()
Returns whether the list of defined command parameter type identifiers has changed.- Returns:
trueif the list of command parameter type identifiers has changed;falseotherwise.- Since:
- 3.2
-
isParameterTypeDefined
public final boolean isParameterTypeDefined()
Returns whether the command parameter type identifier became defined. Otherwise, the command parameter type identifier became undefined.- Returns:
trueif the command parameter type identifier became defined;falseif the command parameter type identifier became undefined.- Since:
- 3.2
-
-