eclipseme.core.model.impl
Class WirelessToolkit

java.lang.Object
  eclipseme.core.model.impl.PlatformComponent
      eclipseme.core.model.impl.WirelessToolkit

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IPlatformComponent, IWirelessToolkit, java.io.Serializable

public abstract class WirelessToolkit

extends PlatformComponent

implements IWirelessToolkit

This is the primary implementation of the IWirelessToolkit interface that assumes Sun's implementation of the wireless toolkit (or one that looks similar to Sun's implementation).

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

See Also:

Serialized Form

Nested Class Summary

static class

WirelessToolkit.WirelessToolkitPersistenceDelegate Persistence delegate for wireless toolkit instances.

Field Summary

static java.lang.String

ATTR_ROOT

Constructor Summary

WirelessToolkit(IWirelessToolkitType type, java.io.File root, java.lang.String identifier, org.eclipse.core.runtime.IProgressMonitor monitor)
Construct a new named toolkit.

Method Summary

void	deregisterDerivedComponents() Deregister all platform components derived/owned by this toolkit.
IConfiguration[]	getConfigurations() Get the J2ME configurations provided by this toolkit.
eclipseme.core.model.registry.IPersistenceDelegate	getPersistenceDelegate() Get the persistence delegate for this particular platform component.
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.
abstract void	initializeToolkit(org.eclipse.core.runtime.IProgressMonitor monitor) Initialize the information that makes up 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 class eclipseme.core.model.impl.PlatformComponent

addDependentComponent, getAdapter, getDependentComponents, getIdentifier, getName, getVersion, hasDependentComponents, isDerived, removeDependentComponent, setDerived

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface eclipseme.core.model.IPlatformComponent

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

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

getAdapter

Field Detail

ATTR_ROOT

public static final java.lang.String ATTR_ROOT

See Also:

Constant Field Values

Constructor Detail

WirelessToolkit

public WirelessToolkit(IWirelessToolkitType type,
                       java.io.File root,
                       java.lang.String identifier,
                       org.eclipse.core.runtime.IProgressMonitor monitor)
                throws InvalidWirelessToolkitException

Construct a new named toolkit.

Parameters:

type - The wireless toolkit type that created and defines this toolkit.

root - The directory in which this toolkit is stored.

monitor - Progress monitor for tracking the operation.

Throws:

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

Method Detail

deregisterDerivedComponents

public void deregisterDerivedComponents()

Description copied from interface: IWirelessToolkit

Deregister all platform components derived/owned by this toolkit.

Specified by:

deregisterDerivedComponents in interface IWirelessToolkit

See Also:

IWirelessToolkit.deregisterDerivedComponents()

getConfigurations

public IConfiguration[] getConfigurations()

Description copied from interface: IWirelessToolkit

Get the J2ME configurations provided by this toolkit.

Specified by:

getConfigurations in interface IWirelessToolkit

Returns:

an array of the configurations provided by this toolkit

See Also:

IWirelessToolkit.getConfigurations()

getPersistenceDelegate

public eclipseme.core.model.registry.IPersistenceDelegate getPersistenceDelegate()

Description copied from interface: IPlatformComponent

Get the persistence delegate for this particular platform component.

Specified by:

getPersistenceDelegate in interface IPlatformComponent

Returns:

a persistence delegate for this component

See Also:

IPlatformComponent.getPersistenceDelegate()

getPlatformDefinitions

public IPlatformDefinition[] getPlatformDefinitions()

Description copied from interface: IWirelessToolkit

Return the IPlatformDefinitions provided by this toolkit.

Specified by:

getPlatformDefinitions in interface IWirelessToolkit

Returns:

an array of the platform definitions provided by this toolkit

See Also:

IWirelessToolkit.getPlatformDefinitions()

getProfiles

public IProfile[] getProfiles()

Description copied from interface: IWirelessToolkit

Get the J2ME profiles provided by this toolkit.

Specified by:

getProfiles in interface IWirelessToolkit

Returns:

an array of the profiles provided by this toolkit

See Also:

IWirelessToolkit.getProfiles()

getRoot

public java.io.File getRoot()

Description copied from interface: IWirelessToolkit

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.

Specified by:

getRoot in interface IWirelessToolkit

Returns:

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

See Also:

IWirelessToolkit.getRoot()

getType

public IWirelessToolkitType getType()

Description copied from interface: IWirelessToolkit

Return the wireless toolkit type associated with this toolkit.

Specified by:

getType in interface IWirelessToolkit

Returns:

the toolkit type associated with this toolkit.

See Also:

IWirelessToolkit.getType()

setRoot

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

Description copied from interface: IWirelessToolkit

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.

Specified by:

setRoot in interface IWirelessToolkit

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.

See Also:

IWirelessToolkit.setRoot(java.io.File, org.eclipse.core.runtime.IProgressMonitor)

initializeToolkit

public abstract void initializeToolkit(org.eclipse.core.runtime.IProgressMonitor monitor)

Initialize the information that makes up this toolkit.

Parameters:

monitor -