diff options
Diffstat (limited to 'target_explorer/plugins/org.eclipse.tcf.te.runtime.stepper/src/org/eclipse/tcf/te/runtime/stepper/interfaces/IContextStepGroupable.java')
| -rw-r--r-- | target_explorer/plugins/org.eclipse.tcf.te.runtime.stepper/src/org/eclipse/tcf/te/runtime/stepper/interfaces/IContextStepGroupable.java | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.runtime.stepper/src/org/eclipse/tcf/te/runtime/stepper/interfaces/IContextStepGroupable.java b/target_explorer/plugins/org.eclipse.tcf.te.runtime.stepper/src/org/eclipse/tcf/te/runtime/stepper/interfaces/IContextStepGroupable.java new file mode 100644 index 000000000..89e21f93a --- /dev/null +++ b/target_explorer/plugins/org.eclipse.tcf.te.runtime.stepper/src/org/eclipse/tcf/te/runtime/stepper/interfaces/IContextStepGroupable.java @@ -0,0 +1,82 @@ +/******************************************************************************* + * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved. + * This program and the accompanying materials are made available under the terms + * of the Eclipse Public License v1.0 which accompanies this distribution, and is + * available at http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Wind River Systems - initial API and implementation + *******************************************************************************/ +package org.eclipse.tcf.te.runtime.stepper.interfaces; + +import org.eclipse.tcf.te.runtime.interfaces.extensions.IExecutableExtension; + +/** + * A step groupable. + */ +public interface IContextStepGroupable { + + /** + * Returns the grouped extension instance. + * + * @return The grouped extension instance. + */ + public IExecutableExtension getExtension(); + + /** + * Returns the groupable secondary id. The primary id is the unique id of the extension. + * + * @return The groupable secondary id or <code>null</code>. + */ + public String getSecondaryId(); + + /** + * Returns if or if not the step is a singleton. Singleton steps can occur in step groups only + * once. Multiple occurrences are forbidden. + * + * @return <code>True</code> if the step is a singleton, <code>false</code> otherwise. + */ + public boolean isSingleton(); + + /** + * Returns if or if not the step can be removed from a step group by the user. + * <p> + * The default value is <code>true</code> and can be changed exactly once to <code>false</code>. + * Once set to <code>false</code> it must not be changeable anymore. + * + * @return <code>True</code> if the step can be removed, <code>false</code> otherwise. + */ + public boolean isRemovable(); + + /** + * Returns if or if not the step is hidden from the user. + * <p> + * The default value is <code>false</code> and can be changed exactly once to <code>true</code>. + * Once set to <code>true</code> it must not be changeable anymore. + * + * @return <code>True</code> if the step is hidden, <code>false</code> otherwise. + */ + public boolean isHidden(); + + /** + * Returns if or if not the step is disabled. + * <p> + * The default value is <code>false</code> and can be changed exactly once to <code>true</code>. + * Once set to <code>true</code> it must not be changeable anymore. + * + * @return <code>True</code> if the step is disable, <code>false</code> otherwise. + */ + public boolean isDisabled(); + + /** + * Returns the list of dependencies. The dependencies of a groupable are checked on execution. + * If one of the listed dependencies have not been executed before, the execution of the + * groupable will fail. + * <p> + * The launch step or launch step group id might be fully qualified using the form + * <code>"primaryId##secondaryId</code>. The <code>secondaryId</code> is optional. + * + * @return The list of dependencies or an empty list. + */ + public String[] getDependencies(); +} |