view dwtx/core/commands/ITypedParameter.d @ 3:6518c18a01f7

eclipse.core package without osgi dependencies
author Frank Benoit <benoit@tionex.de>
date Wed, 26 Mar 2008 00:57:19 +0100
parents
children
line wrap: on
line source

/*******************************************************************************
 * Copyright (c) 2005, 2006 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.ITypedParameter;

import dwtx.core.commands.ParameterType;

/**
 * A command parameter that has a declared type. This interface is intended to
 * be implemented by implementors of {@link IParameter} that will support
 * parameter types.
 *
 * @since 3.2
 */
public interface ITypedParameter {

    /**
     * Returns the {@link ParameterType} associated with a command parameter or
     * <code>null</code> if the parameter does not declare a type.
     * <p>
     * Note that the parameter type returned may be undefined.
     * </p>
     *
     * @return the parameter type associated with a command parameter or
     *         <code>null</code> if the parameter does not declare a type
     */
    public ParameterType getParameterType();
}