eclipseme.core.model
Interface IPlatformComponent

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

All Known Subinterfaces:

IConfiguration, IEmulator, IExecutableEmulator, IJavaBasedEmulator, IPlatformDefinition, IProfile, IWirelessToolkit

All Known Implementing Classes:

AbstractEmulator, Configuration, PlatformComponent, PlatformDefinition, Profile, WirelessToolkit

public interface IPlatformComponent

extends org.eclipse.core.runtime.IAdaptable

Implementations of all J2ME platform components, including wireless toolkits, configurations and profiles implement this interface. Platform components may have dependent platform components. Components that have one or more dependencies may not be deletable from the user interface.

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:56 $

Author:

Craig Setera

Method Summary

void	addDependentComponent(IPlatformComponent component) Add a component to the list of components that are dependent on this component.
java.util.Iterator	getDependentComponents() Return an Iterator on the list of components that are dependent on this component.
java.lang.String	getIdentifier() Return the unique identifier of this platform component.
java.lang.String	getName() Return the name of this platform component.
eclipseme.core.model.registry.IPersistenceDelegate	getPersistenceDelegate() Get the persistence delegate for this particular platform component.
Version	getVersion() Get the version of this platform component.
boolean	hasDependentComponents() Return a boolean indicating whether there are components that are dependent on this component.
boolean	isDerived() Return a boolean indicating whether or not this component is derived from another component.
void	removeDependentComponent(IPlatformComponent component) Remove a component from the list of components that are dependent on this component.

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

getAdapter

Method Detail

addDependentComponent

public void addDependentComponent(IPlatformComponent component)

Add a component to the list of components that are dependent on this component.

Parameters:

component - the dependent component

getDependentComponents

public java.util.Iterator getDependentComponents()

Return an Iterator on the list of components that are dependent on this component.

Returns:

the components dependent on this component

getIdentifier

public java.lang.String getIdentifier()

Return the unique identifier of this platform component. This identifier must be unique across all components of the same type (platform definition, profile, configuration, etc.) and must not be null.

Returns:

the unique identifier for this platform component. This value should never be null.

getName

public java.lang.String getName()

Return the name of this platform component.

Returns:

The name. This value should never be null.

getPersistenceDelegate

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

Get the persistence delegate for this particular platform component.

Returns:

a persistence delegate for this component

getVersion

public Version getVersion()

Get the version of this platform component.

Returns:

the version of this component

hasDependentComponents

public boolean hasDependentComponents()

Return a boolean indicating whether there are components that are dependent on this component.

Returns:

whether this component has dependent components

isDerived

public boolean isDerived()

Return a boolean indicating whether or not this component is derived from another component. Derived components are not persisted directly, as they are handled by their owning component.

Returns:

whether this component is a derivative of another component

removeDependentComponent

public void removeDependentComponent(IPlatformComponent component)

Remove a component from the list of components that are dependent on this component.

Parameters:

component - the component to be removed