eclipseme.core.model
Interface IWirelessToolkit

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IPlatformComponent

All Known Implementing Classes:

WirelessToolkit

public interface IWirelessToolkit

extends IPlatformComponent

Representation of a wireless toolkit instance on the file system. Different wireless toolkits may have different features. This interface defines the required functionality.

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

void	deregisterDerivedComponents() Deregister all platform components derived/owned by this toolkit.
IConfiguration[]	getConfigurations() Get the J2ME configurations provided by this toolkit.
IPlatformDefinition[]	getPlatformDefinitions() Return the IPlatformDefinitions provided by this toolkit.
IProfile[]	getProfiles() Get the J2ME profiles provided by this toolkit.
java.io.File	getRoot() Get the current file system root in which this toolkit is stored.
IWirelessToolkitType	getType() Return the wireless toolkit type associated with this toolkit.
void	setRoot(java.io.File root, org.eclipse.core.runtime.IProgressMonitor monitor) Set the current file system root in which this toolkit is stored.

Methods inherited from interface eclipseme.core.model.IPlatformComponent

addDependentComponent, getDependentComponents, getIdentifier, getName, getPersistenceDelegate, getVersion, hasDependentComponents, isDerived, removeDependentComponent

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

deregisterDerivedComponents

public void deregisterDerivedComponents()

Deregister all platform components derived/owned by this toolkit.

getConfigurations

public IConfiguration[] getConfigurations()

Get the J2ME configurations provided by this toolkit.

Returns:

an array of the configurations provided by this toolkit

getPlatformDefinitions

public IPlatformDefinition[] getPlatformDefinitions()

Return the IPlatformDefinitions provided by this toolkit.

Returns:

an array of the platform definitions provided by this toolkit

getProfiles

public IProfile[] getProfiles()

Get the J2ME profiles provided by this toolkit.

Returns:

an array of the profiles provided by this toolkit

getRoot

public java.io.File getRoot()

Get the current file system root in which this toolkit is stored. This root variable may be changed, which will be reflected in the value of the classpath variable.

Returns:

The File instance representing the directory in which the toolkit is installed.

getType

public IWirelessToolkitType getType()

Return the wireless toolkit type associated with this toolkit.

Returns:

the toolkit type associated with this toolkit.

setRoot

public void setRoot(java.io.File root,
                    org.eclipse.core.runtime.IProgressMonitor monitor)
             throws InvalidWirelessToolkitException

Set the current file system root in which this toolkit is stored. This root variable may be changed, which will be reflected in the value of the classpath variable.

Parameters:

root - The File instance representing the directory in which the toolkit is installed.

Throws:

InvalidWirelessToolkitException - If the specified root does not exist or does not contain a valid wireless toolkit.