Mercurial > projects > dwt-addons
view dwtx/core/commands/IParameter.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 | 6518c18a01f7 |
children |
line wrap: on
line source
/******************************************************************************* * Copyright (c) 2005 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation * Port to the D programming language: * Frank Benoit <benoit@tionex.de> ******************************************************************************/ module dwtx.core.commands.IParameter; import dwtx.core.commands.IParameterValues; import dwt.dwthelper.utils; /** * <p> * A parameter for a command. A parameter identifies a type of information that * the command might accept. For example, a "Show View" command might accept the * id of a view for display. This parameter also identifies possible values, for * display in the user interface. * </p> * * @since 3.1 */ public interface IParameter { /** * Returns the identifier for this parameter. * * @return The identifier; never <code>null</code>. */ public String getId(); /** * Returns the human-readable name for this parameter. * * @return The parameter name; never <code>null</code>. */ public String getName(); /** * Returns the values associated with this parameter. * * @return The values associated with this parameter. This must not be * <code>null</code>. * @throws ParameterValuesException * If the values can't be retrieved for some reason. */ public IParameterValues getValues(); /** * Returns whether parameter is optional. Otherwise, it is required. * * @return <code>true</code> if the parameter is optional; * <code>false</code> if it is required. */ public bool isOptional(); }