projects/dwt-addons: dwtx/core/commands/ParameterizedCommand.d annotate

annotate dwtx/core/commands/ParameterizedCommand.d @ 104:04b47443bb01

Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. These new wrappers now use the tango.util.containers instead of the tango.util.collections.

author	Frank Benoit <benoit@tionex.de>
date	Thu, 07 Aug 2008 15:01:33 +0200
parents	4878bef4a38e
children

rev	line source
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	1 /*******************************************************************************
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	2 * Copyright (c) 2005, 2008 IBM Corporation and others.
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	3 * All rights reserved. This program and the accompanying materials
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	4 * are made available under the terms of the Eclipse Public License v1.0
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	5 * which accompanies this distribution, and is available at
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	6 * http://www.eclipse.org/legal/epl-v10.html
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	7 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	8 * Contributors:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	9 * IBM Corporation - initial API and implementation
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	10 * Benjamin Muskalla - bug 222861 [Commands] ParameterizedCommand#equals broken
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	11 * Port to the D programming language:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	12 * Frank Benoit <benoit@tionex.de>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	13 *******************************************************************************/
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	14
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	15 module dwtx.core.commands.ParameterizedCommand;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	16
71 4878bef4a38e Some fixing Frank Benoit <benoit@tionex.de> parents: 70 diff changeset	17 import dwtx.core.commands.AbstractParameterValueConverter;
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	18 import dwtx.core.commands.Command;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	19 import dwtx.core.commands.CommandManager;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	20 import dwtx.core.commands.IParameter;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	21 import dwtx.core.commands.IParameterValues;
71 4878bef4a38e Some fixing Frank Benoit <benoit@tionex.de> parents: 70 diff changeset	22 import dwtx.core.commands.ParameterType;
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	23 import dwtx.core.commands.Parameterization;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	24 import dwtx.core.commands.ParameterValuesException;
71 4878bef4a38e Some fixing Frank Benoit <benoit@tionex.de> parents: 70 diff changeset	25 import dwtx.core.commands.ParameterValueConversionException;
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	26 import dwtx.core.commands.ExecutionEvent;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	27 import dwtx.core.commands.common.NotDefinedException;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	28 import dwtx.core.internal.commands.util.Util;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	29 import dwt.dwthelper.utils;
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	30 import dwtx.dwtxhelper.Collection;
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	31 import tango.text.convert.Format;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	32
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	33 static import tango.text.Text;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	34 alias tango.text.Text.Text!(char) StringBuffer;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	35
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	36 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	37 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	38 * A command that has had one or more of its parameters specified. This class
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	39 * serves as a utility class for developers that need to manipulate commands
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	40 * with parameters. It handles the behaviour of generating a parameter map and a
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	41 * human-readable name.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	42 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	43 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	44 * @since 3.1
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	45 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	46 public final class ParameterizedCommand : Comparable {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	47 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	48 * The constant integer hash code value meaning the hash code has not yet
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	49 * been computed.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	50 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	51 private static const int HASH_CODE_NOT_COMPUTED = -1;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	52
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	53 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	54 * A factor for computing the hash code for all parameterized commands.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	55 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	56 private static const int HASH_FACTOR = 89;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	57
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	58 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	59 * The seed for the hash code for all parameterized commands.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	60 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	61 private static const int HASH_INITIAL;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	62
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	63 static this(){
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	64 HASH_INITIAL = dwt.dwthelper.utils.toHash(ParameterizedCommand.classinfo.name );
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	65 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	66 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	67 * The index of the parameter id in the parameter values.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	68 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	69 * @deprecated no longer used
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	70 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	71 public static const int INDEX_PARAMETER_ID = 0;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	72
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	73 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	74 * The index of the human-readable name of the parameter itself, in the
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	75 * parameter values.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	76 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	77 * @deprecated no longer used
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	78 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	79 public static const int INDEX_PARAMETER_NAME = 1;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	80
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	81 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	82 * The index of the human-readable name of the value of the parameter for
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	83 * this command.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	84 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	85 * @deprecated no longer used
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	86 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	87 public static const int INDEX_PARAMETER_VALUE_NAME = 2;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	88
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	89 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	90 * The index of the value of the parameter that the command can understand.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	91 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	92 * @deprecated no longer used
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	93 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	94 public static const int INDEX_PARAMETER_VALUE_VALUE = 3;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	95
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	96 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	97 * Escapes special characters in the command id, parameter ids and parameter
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	98 * values for {@link #serialize()}. The special characters
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	99 * {@link CommandManager#PARAMETER_START_CHAR},
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	100 * {@link CommandManager#PARAMETER_END_CHAR},
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	101 * {@link CommandManager#ID_VALUE_CHAR},
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	102 * {@link CommandManager#PARAMETER_SEPARATOR_CHAR} and
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	103 * {@link CommandManager#ESCAPE_CHAR} are escaped by prepending a
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	104 * {@link CommandManager#ESCAPE_CHAR} character.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	105 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	106 * @param rawText
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	107 * a <code>String</code> to escape special characters in for
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	108 * serialization.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	109 * @return a <code>String</code> representing <code>rawText</code> with
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	110 * special serialization characters escaped
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	111 * @since 3.2
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	112 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	113 private static final String escape(String rawText) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	114
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	115 // defer initialization of a StringBuffer until we know we need one
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	116 StringBuffer buffer;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	117
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	118 for (int i = 0; i < rawText.length; i++) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	119
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	120 char c = rawText.charAt(i);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	121 switch (c) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	122 case CommandManager.PARAMETER_START_CHAR:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	123 case CommandManager.PARAMETER_END_CHAR:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	124 case CommandManager.ID_VALUE_CHAR:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	125 case CommandManager.PARAMETER_SEPARATOR_CHAR:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	126 case CommandManager.ESCAPE_CHAR:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	127 if (buffer is null) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	128 buffer = new StringBuffer(rawText.substring(0, i));
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	129 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	130 buffer.append(CommandManager.ESCAPE_CHAR);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	131 buffer.append(c);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	132 break;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	133 default:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	134 if (buffer !is null) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	135 buffer.append(c);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	136 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	137 break;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	138 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	139
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	140 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	141
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	142 if (buffer is null) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	143 return rawText;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	144 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	145 return buffer.toString();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	146 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	147
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	148 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	149 * Generates every possible combination of parameter values for the given
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	150 * parameters. Parameters values that cannot be initialized are just
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	151 * ignored. Optional parameters are considered.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	152 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	153 * @param startIndex
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	154 * The index in the <code>parameters</code> that we should
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	155 * process. This must be a valid index.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	156 * @param parameters
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	157 * The parameters in to process; must not be <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	158 * @return A collection (<code>Collection</code>) of combinations (<code>List</code>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	159 * of <code>Parameterization</code>).
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	160 */
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	161 private static final Collection expandParameters(int startIndex,
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	162 IParameter[] parameters) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	163 int nextIndex = startIndex + 1;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	164 bool noMoreParameters = (nextIndex >= parameters.length);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	165
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	166 IParameter parameter = parameters[startIndex];
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	167 List parameterizations = new ArrayList();
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	168 if (parameter.isOptional()) {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	169 parameterizations.add( cast(Object) null);
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	170 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	171
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	172 IParameterValues values = null;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	173 try {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	174 values = parameter.getValues();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	175 } catch (ParameterValuesException e) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	176 if (noMoreParameters) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	177 return parameterizations;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	178 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	179
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	180 // Make recursive call
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	181 return expandParameters(nextIndex, parameters);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	182 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	183
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	184 Map parameterValues = values.getParameterValues();
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	185 Iterator parameterValueItr = parameterValues.entrySet()
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	186 .iterator();
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	187 while (parameterValueItr.hasNext()) {
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	188 Map.Entry entry = cast(Map.Entry) parameterValueItr.next();
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	189 Parameterization parameterization = new Parameterization(
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	190 parameter, stringcast( entry.getValue()));
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	191 parameterizations.add(parameterization);
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	192 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	193
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	194 // Check if another iteration will produce any more names.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	195 int parameterizationCount = parameterizations.size();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	196 if (noMoreParameters) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	197 // This is it, so just return the current parameterizations.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	198 for (int i = 0; i < parameterizationCount; i++) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	199 Parameterization parameterization = cast(Parameterization) parameterizations
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	200 .get(i);
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	201 List combination = new ArrayList();
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	202 combination.add(parameterization);
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	203 parameterizations.set(i, cast(Object)combination);
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	204 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	205 return parameterizations;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	206 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	207
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	208 // Make recursive call
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	209 Collection suffixes = expandParameters(nextIndex, parameters);
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	210 while (suffixes.remove(cast(Object)null)) {
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	211 // just keep deleting the darn things.
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	212 }
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	213 if (suffixes.isEmpty()) {
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	214 // This is it, so just return the current parameterizations.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	215 for (int i = 0; i < parameterizationCount; i++) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	216 Parameterization parameterization = cast(Parameterization) parameterizations
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	217 .get(i);
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	218 List combination = new ArrayList();
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	219 combination.add(parameterization);
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	220 parameterizations.set(i,cast(Object) combination);
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	221 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	222 return parameterizations;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	223 }
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	224 Collection returnValue = new ArrayList();
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	225 Iterator suffixItr = suffixes.iterator();
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	226 while (suffixItr.hasNext()) {
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	227 List combination = cast(List) suffixItr.next();
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	228 int combinationSize = combination.size();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	229 for (int i = 0; i < parameterizationCount; i++) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	230 Parameterization parameterization = cast(Parameterization) parameterizations
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	231 .get(i);
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	232 List newCombination = new ArrayList(combinationSize + 1);
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	233 newCombination.add(parameterization);
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	234 newCombination.addAll(combination);
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	235 returnValue.add(cast(Object)newCombination);
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	236 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	237 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	238
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	239 return returnValue;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	240 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	241
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	242 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	243 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	244 * Generates all the possible combinations of command parameterizations for
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	245 * the given command. If the command has no parameters, then this is simply
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	246 * a parameterized version of that command. If a parameter is optional, both
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	247 * the included and not included cases are considered.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	248 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	249 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	250 * If one of the parameters cannot be loaded due to a
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	251 * <code>ParameterValuesException</code>, then it is simply ignored.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	252 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	253 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	254 * @param command
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	255 * The command for which the parameter combinations should be
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	256 * generated; must not be <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	257 * @return A collection of <code>ParameterizedCommand</code> instances
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	258 * representing all of the possible combinations. This value is
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	259 * never empty and it is never <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	260 * @throws NotDefinedException
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	261 * If the command is not defined.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	262 */
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	263 public static final Collection generateCombinations(Command command) {
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	264 IParameter[] parameters = command.getParameters();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	265 if (parameters is null) {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	266 return Collections
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	267 .singleton(new ParameterizedCommand(command, null));
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	268 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	269
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	270 Collection expansion = expandParameters(0, parameters);
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	271 Collection combinations = new ArrayList(expansion.size());
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	272 Iterator expansionItr = expansion.iterator();
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	273 while (expansionItr.hasNext()) {
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	274 List combination = cast(List) expansionItr.next();
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	275 if (combination is null) {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	276 combinations.add(new ParameterizedCommand(command, null));
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	277 } else {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	278 while (combination.remove(cast(Object)null)) {
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	279 // Just keep removing while there are null entries left.
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	280 }
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	281 if (combination.isEmpty()) {
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	282 combinations.add(new ParameterizedCommand(command, null));
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	283 } else {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	284 Parameterization[] parameterizations = arraycast!(Parameterization)( combination
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	285 .toArray());
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	286 combinations.add(new ParameterizedCommand(command,
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	287 parameterizations));
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	288 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	289 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	290 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	291
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	292 return combinations;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	293 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	294
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	295 /**
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	296 * Take a command and a map of parameter IDs to values, and generate the
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	297 * appropriate parameterized command.
71 4878bef4a38e Some fixing Frank Benoit <benoit@tionex.de> parents: 70 diff changeset	298 *
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	299 * @param command
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	300 * The command object. Must not be <code>null</code>.
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	301 * @param parameters
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	302 * A map of String parameter ids to objects. May be
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	303 * <code>null</code>.
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	304 * @return the parameterized command, or <code>null</code> if it could not
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	305 * be generated
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	306 * @since 3.4
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	307 */
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	308 public static final ParameterizedCommand generateCommand(Command command,
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	309 Map parameters) {
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	310 // no parameters
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	311 if (parameters is null \|\| parameters.isEmpty()) {
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	312 return new ParameterizedCommand(command, null);
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	313 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	314
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	315 try {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	316 ArrayList parms = new ArrayList();
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	317 Iterator i = parameters.keySet().iterator();
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	318
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	319 // iterate over given parameters
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	320 while (i.hasNext()) {
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	321 String key = stringcast( i.next() );
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	322 IParameter parameter = null;
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	323 // get the parameter from the command
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	324 parameter = command.getParameter(key);
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	325
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	326 // if the parameter is defined add it to the parameter list
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	327 if (parameter is null) {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	328 return null;
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	329 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	330 ParameterType parameterType = command.getParameterType(key);
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	331 if (parameterType is null) {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	332 parms.add(new Parameterization(parameter,
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	333 stringcast( parameters.get(key))));
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	334 } else {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	335 AbstractParameterValueConverter valueConverter = parameterType
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	336 .getValueConverter();
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	337 if (valueConverter !is null) {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	338 String val = valueConverter.convertToString( parameters
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	339 .get(key));
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	340 parms.add(new Parameterization(parameter, val));
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	341 } else {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	342 parms.add(new Parameterization(parameter,
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	343 stringcast(parameters.get(key))));
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	344 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	345 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	346 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	347
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	348 // convert the parameters to an Parameterization array and create
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	349 // the command
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	350 return new ParameterizedCommand(command, arraycast!(Parameterization)( parms
04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	351 .toArray()));
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	352 } catch (NotDefinedException e) {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	353 } catch (ParameterValueConversionException e) {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	354 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	355 return null;
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	356 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	357
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	358 /**
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	359 * The base command which is being parameterized. This value is never
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	360 * <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	361 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	362 private const Command command;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	363
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	364 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	365 * The hash code for this object. This value is computed lazily, and marked
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	366 * as invalid when one of the values on which it is based changes.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	367 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	368 private /+transient+/ int hashCode = HASH_CODE_NOT_COMPUTED;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	369
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	370 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	371 * This is an array of parameterization defined for this command. This value
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	372 * may be <code>null</code> if the command has no parameters.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	373 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	374 private const Parameterization[] parameterizations;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	375
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	376 private String name;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	377
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	378 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	379 * Constructs a new instance of <code>ParameterizedCommand</code> with
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	380 * specific values for zero or more of its parameters.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	381 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	382 * @param command
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	383 * The command that is parameterized; must not be
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	384 * <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	385 * @param parameterizations
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	386 * An array of parameterizations binding parameters to values for
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	387 * the command. This value may be <code>null</code>.
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	388 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	389 public this(Command command,
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	390 Parameterization[] parameterizations) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	391 if (command is null) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	392 throw new NullPointerException(
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	393 "A parameterized command cannot have a null command"); //$NON-NLS-1$
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	394 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	395
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	396 this.command = command;
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	397 IParameter[] parms = null;
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	398 try {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	399 parms = command.getParameters();
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	400 } catch (NotDefinedException e) {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	401 // This should not happen.
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	402 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	403 if (parameterizations !is null && parameterizations.length>0 && parms !is null) {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	404 int parmIndex = 0;
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	405 Parameterization[] params = new Parameterization[parameterizations.length];
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	406 for (int j = 0; j < parms.length; j++) {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	407 for (int i = 0; i < parameterizations.length; i++) {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	408 Parameterization pm = parameterizations[i];
71 4878bef4a38e Some fixing Frank Benoit <benoit@tionex.de> parents: 70 diff changeset	409 if ((cast(Object)parms[j]).opEquals(cast(Object)pm.getParameter())) {
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	410 params[parmIndex++] = pm;
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	411 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	412 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	413 }
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	414 this.parameterizations = params;
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	415 } else {
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	416 this.parameterizations = null;
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	417 }
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	418 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	419
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	420 /*
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	421 * (non-Javadoc)
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	422 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	423 * @see java.lang.Comparable#compareTo(java.lang.Object)
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	424 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	425 public final int compareTo(Object object) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	426 ParameterizedCommand command = cast(ParameterizedCommand) object;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	427 bool thisDefined = this.command.isDefined();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	428 bool otherDefined = command.command.isDefined();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	429 if (!thisDefined \|\| !otherDefined) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	430 return Util.compare(thisDefined, otherDefined);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	431 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	432
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	433 try {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	434 int compareTo = getName() < command.getName();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	435 if (compareTo is 0) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	436 return getId() < command.getId();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	437 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	438 return compareTo;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	439 } catch (NotDefinedException e) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	440 throw new Exception (
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	441 "Concurrent modification of a command's defined state"); //$NON-NLS-1$
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	442 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	443 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	444
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	445 /*
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	446 * (non-Javadoc)
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	447 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	448 * @see java.lang.Object#equals(java.lang.Object)
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	449 */
43 ea8ff534f622 Fix override and super aliases Frank Benoit <benoit@tionex.de> parents: 3 diff changeset	450 public override final int opEquals(Object object) {
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	451 if (this is object) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	452 return true;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	453 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	454
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	455 if (!(cast(ParameterizedCommand)object)) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	456 return false;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	457 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	458
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	459 ParameterizedCommand command = cast(ParameterizedCommand) object;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	460 if (!Util.equals(this.command, command.command)) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	461 return false;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	462 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	463
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	464 return Util.equals(this.parameterizations, command.parameterizations);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	465 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	466
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	467 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	468 * Executes this command with its parameters. This method will succeed
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	469 * regardless of whether the command is enabled or defined. It is
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	470 * preferrable to use {@link #executeWithChecks(Object, Object)}.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	471 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	472 * @param trigger
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	473 * The object that triggered the execution; may be
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	474 * <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	475 * @param applicationContext
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	476 * The state of the application at the time the execution was
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	477 * triggered; may be <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	478 * @return The result of the execution; may be <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	479 * @throws ExecutionException
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	480 * If the handler has problems executing this command.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	481 * @throws NotHandledException
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	482 * If there is no handler.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	483 * @deprecated Please use {@link #executeWithChecks(Object, Object)}
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	484 * instead.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	485 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	486 public final Object execute(Object trigger,
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	487 Object applicationContext) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	488 return command.execute(new ExecutionEvent(command, getParameterMap(),
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	489 trigger, applicationContext));
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	490 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	491
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	492 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	493 * Executes this command with its parameters. This does extra checking to
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	494 * see if the command is enabled and defined. If it is not both enabled and
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	495 * defined, then the execution listeners will be notified and an exception
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	496 * thrown.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	497 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	498 * @param trigger
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	499 * The object that triggered the execution; may be
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	500 * <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	501 * @param applicationContext
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	502 * The state of the application at the time the execution was
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	503 * triggered; may be <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	504 * @return The result of the execution; may be <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	505 * @throws ExecutionException
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	506 * If the handler has problems executing this command.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	507 * @throws NotDefinedException
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	508 * If the command you are trying to execute is not defined.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	509 * @throws NotEnabledException
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	510 * If the command you are trying to execute is not enabled.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	511 * @throws NotHandledException
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	512 * If there is no handler.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	513 * @since 3.2
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	514 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	515 public final Object executeWithChecks(Object trigger,
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	516 Object applicationContext) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	517 return command.executeWithChecks(new ExecutionEvent(command,
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	518 getParameterMap(), trigger, applicationContext));
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	519 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	520
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	521 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	522 * Returns the base command. It is possible for more than one parameterized
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	523 * command to have the same identifier.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	524 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	525 * @return The command; never <code>null</code>, but may be undefined.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	526 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	527 public final Command getCommand() {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	528 return command;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	529 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	530
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	531 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	532 * Returns the command's base identifier. It is possible for more than one
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	533 * parameterized command to have the same identifier.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	534 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	535 * @return The command id; never <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	536 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	537 public final String getId() {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	538 return command.getId();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	539 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	540
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	541 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	542 * Returns a human-readable representation of this command with all of its
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	543 * parameterizations.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	544 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	545 * @return The human-readable representation of this parameterized command;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	546 * never <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	547 * @throws NotDefinedException
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	548 * If the underlying command is not defined.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	549 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	550 public final String getName() {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	551 if (name is null) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	552 StringBuffer nameBuffer = new StringBuffer();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	553 nameBuffer.append(command.getName());
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	554 if (parameterizations !is null) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	555 nameBuffer.append(" ("); //$NON-NLS-1$
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	556 int parameterizationCount = parameterizations.length;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	557 for (int i = 0; i < parameterizationCount; i++) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	558 Parameterization parameterization = parameterizations[i];
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	559 nameBuffer
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	560 .append(parameterization.getParameter().getName());
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	561 nameBuffer.append(": "); //$NON-NLS-1$
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	562 try {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	563 nameBuffer.append(parameterization.getValueName());
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	564 } catch (ParameterValuesException e) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	565 /*
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	566 * Just let it go for now. If someone complains we can
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	567 * add more info later.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	568 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	569 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	570
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	571 // If there is another item, append a separator.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	572 if (i + 1 < parameterizationCount) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	573 nameBuffer.append(", "); //$NON-NLS-1$
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	574 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	575 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	576 nameBuffer.append(')');
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	577 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	578 name = nameBuffer.toString();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	579 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	580 return name;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	581 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	582
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	583 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	584 * Returns the parameter map, as can be used to construct an
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	585 * <code>ExecutionEvent</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	586 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	587 * @return The map of parameter ids (<code>String</code>) to parameter
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	588 * values (<code>String</code>). This map is never
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	589 * <code>null</code>, but may be empty.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	590 */
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	591 public final Map getParameterMap() {
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	592 if ((parameterizations is null) \|\| (parameterizations.length is 0)) {
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	593 return Collections.EMPTY_MAP;
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	594 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	595
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	596 Map parameterMap = new HashMap();
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	597 for (int i = 0; i < parameterizations.length; i++) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	598 Parameterization parameterization = parameterizations[i];
104 04b47443bb01 Reworked the collection uses to make use of a wrapper collection that is compatible to the Java Collections. Frank Benoit <benoit@tionex.de> parents: 71 diff changeset	599 parameterMap.put(parameterization.getParameter().getId(),
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	600 parameterization.getValue());
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	601 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	602 return parameterMap;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	603 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	604
70 46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	605 /*
46a6e0e6ccd4 Merge with d-fied sources of 3.4M7 Frank Benoit <benoit@tionex.de> parents: 43 diff changeset	606 * (non-Javadoc)
71 4878bef4a38e Some fixing Frank Benoit <benoit@tionex.de> parents: 70 diff changeset	607 *
3 6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	608 * @see java.lang.Object#hashCode()
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	609 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	610 public override final hash_t toHash() {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	611 if (hashCode is HASH_CODE_NOT_COMPUTED) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	612 hashCode = HASH_INITIAL * HASH_FACTOR + Util.toHash(command);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	613 hashCode = hashCode * HASH_FACTOR;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	614 if (parameterizations !is null) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	615 for (int i = 0; i < parameterizations.length; i++) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	616 hashCode += Util.toHash(parameterizations[i]);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	617 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	618 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	619 if (hashCode is HASH_CODE_NOT_COMPUTED) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	620 hashCode++;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	621 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	622 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	623 return hashCode;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	624 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	625
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	626 /**
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	627 * Returns a {@link String} containing the command id, parameter ids and
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	628 * parameter values for this {@link ParameterizedCommand}. The returned
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	629 * {@link String} can be stored by a client and later used to reconstruct an
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	630 * equivalent {@link ParameterizedCommand} using the
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	631 * {@link CommandManager#deserialize(String)} method.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	632 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	633 * The syntax of the returned {@link String} is as follows:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	634 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	635 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	636 * <blockquote>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	637 * <code>serialization = <u>commandId</u> [ '(' parameters ')' ]</code><br>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	638 * <code>parameters = parameter [ ',' parameters ]</code><br>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	639 * <code>parameter = <u>parameterId</u> [ '=' <u>parameterValue</u> ]</code>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	640 * </blockquote>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	641 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	642 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	643 * In the syntax above, sections inside square-brackets are optional. The
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	644 * characters in single quotes (<code>(</code>, <code>)</code>,
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	645 * <code>,</code> and <code>=</code>) indicate literal characters.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	646 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	647 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	648 * <code><u>commandId</u></code> represents the command id encoded with
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	649 * separator characters escaped. <code><u>parameterId</u></code> and
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	650 * <code><u>parameterValue</u></code> represent the parameter ids and
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	651 * values encoded with separator characters escaped. The separator
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	652 * characters <code>(</code>, <code>)</code>, <code>,</code> and
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	653 * <code>=</code> are escaped by prepending a <code>%</code>. This
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	654 * requires <code>%</code> to be escaped, which is also done by prepending
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	655 * a <code>%</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	656 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	657 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	658 * The order of the parameters is not defined (and not important). A missing
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	659 * <code><u>parameterValue</u></code> indicates that the value of the
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	660 * parameter is <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	661 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	662 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	663 * For example, the string shown below represents a serialized parameterized
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	664 * command that can be used to show the Resource perspective:
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	665 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	666 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	667 * <code>dwtx.ui.perspectives.showPerspective(dwtx.ui.perspectives.showPerspective.perspectiveId=dwtx.ui.resourcePerspective)</code>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	668 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	669 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	670 * This example shows the more general form with multiple parameters,
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	671 * <code>null</code> value parameters, and escaped <code>=</code> in the
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	672 * third parameter value.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	673 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	674 * <p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	675 * <code>command.id(param1.id=value1,param2.id,param3.id=esc%=val3)</code>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	676 * </p>
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	677 *
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	678 * @return A string containing the escaped command id, parameter ids and
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	679 * parameter values; never <code>null</code>.
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	680 * @see CommandManager#deserialize(String)
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	681 * @since 3.2
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	682 */
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	683 public final String serialize() {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	684 String escapedId = escape(getId());
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	685
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	686 if ((parameterizations is null) \|\| (parameterizations.length is 0)) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	687 return escapedId;
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	688 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	689
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	690 StringBuffer buffer = new StringBuffer(escapedId);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	691 buffer.append(CommandManager.PARAMETER_START_CHAR);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	692
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	693 for (int i = 0; i < parameterizations.length; i++) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	694
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	695 if (i > 0) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	696 // insert separator between parameters
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	697 buffer.append(CommandManager.PARAMETER_SEPARATOR_CHAR);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	698 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	699
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	700 Parameterization parameterization = parameterizations[i];
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	701 String parameterId = parameterization.getParameter().getId();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	702 String escapedParameterId = escape(parameterId);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	703
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	704 buffer.append(escapedParameterId);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	705
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	706 String parameterValue = parameterization.getValue();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	707 if (parameterValue !is null) {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	708 String escapedParameterValue = escape(parameterValue);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	709 buffer.append(CommandManager.ID_VALUE_CHAR);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	710 buffer.append(escapedParameterValue);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	711 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	712 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	713
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	714 buffer.append(CommandManager.PARAMETER_END_CHAR);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	715
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	716 return buffer.toString();
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	717 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	718
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	719 public override final String toString() {
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	720 return Format( "ParameterizedCommand({},{})", command, parameterizations);
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	721 }
6518c18a01f7 eclipse.core package without osgi dependencies Frank Benoit <benoit@tionex.de> parents: diff changeset	722 }

Mercurial > projects > dwt-addons

annotate dwtx/core/commands/ParameterizedCommand.d @ 104:04b47443bb01