eclipseme.core.model
Interface IWirelessToolkitType

All Known Implementing Classes:

AbstractWirelessToolkitType

public interface IWirelessToolkitType

Implementations of this interface represent certain types of wireless toolkit implementations. In addition, instances of this class act as a factory for IWirelessToolkit instances.

Note: This class/interface is part of an interim API that is still under development and expected to change before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken as the API evolves.

Copyright (c) 2003-2005 Craig Setera
All Rights Reserved.
Licensed under the Eclipse Public License - v 1.0

$Revision: 1.5 $
$Date: 2005/07/07 02:36:57 $

Author:

Craig Setera

Method Summary

IWirelessToolkit	createToolkit(java.io.File toolkitRoot, org.eclipse.core.runtime.IProgressMonitor monitor) Return a newly created IWirelessTookit instance for this wireless toolkit type based on the specified toolkit root directory.
java.lang.String	getIdentifier() Return the unique identifier for this particular IWirelessToolkitType as defined by the toolkit type extension point.
java.lang.String	getName() Get the name of this wireless toolkit type.
java.lang.String	getPluginIdentifier() Return the identifier of the Eclipse plugin that implements this toolkit type.
boolean	isThisType(java.io.File toolkitRoot) Return a boolean indicating whether or not the specified directory is the root of a toolkit of this type.
void	setIdentifier(java.lang.String identifier) Set the unique identifier for this particular IWirelessToolkitType as defined by the toolkit type extension point.
void	setPluginIdentifier(java.lang.String identifier) Set the identifier of the Eclipse plugin that implements this toolkit type.

Method Detail

createToolkit

public IWirelessToolkit createToolkit(java.io.File toolkitRoot,
                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                               throws InvalidWirelessToolkitException

Return a newly created IWirelessTookit instance for this wireless toolkit type based on the specified toolkit root directory.

Parameters:

toolkitRoot -

monitor -

Returns:

the newly created toolkit

Throws:

InvalidWirelessToolkitException

getIdentifier

public java.lang.String getIdentifier()

Return the unique identifier for this particular IWirelessToolkitType as defined by the toolkit type extension point.

Returns:

the unique identifier for this particular IWirelessToolkitType

getName

public java.lang.String getName()

Get the name of this wireless toolkit type.

Returns:

the name of the wireless toolkit type

getPluginIdentifier

public java.lang.String getPluginIdentifier()

Return the identifier of the Eclipse plugin that implements this toolkit type.

Returns:

the toolkit type's plugin identifier

isThisType

public boolean isThisType(java.io.File toolkitRoot)

Return a boolean indicating whether or not the specified directory is the root of a toolkit of this type.

Parameters:

toolkitRoot -

Returns:

a boolean representing whether the root is handled by this toolkit type

setIdentifier

public void setIdentifier(java.lang.String identifier)

Set the unique identifier for this particular IWirelessToolkitType as defined by the toolkit type extension point.

Parameters:

identifier - the unique identifier for this particular IWirelessToolkitType

setPluginIdentifier

public void setPluginIdentifier(java.lang.String identifier)

Set the identifier of the Eclipse plugin that implements this toolkit type.

Parameters:

identifier - the toolkit type's plugin identifier