Faceted Project Framework
Version 1.3

org.eclipse.wst.common.project.facet.core.runtime
Interface IRuntimeComponent

All Superinterfaces:
IAdaptable

public interface IRuntimeComponent
extends IAdaptable

Represents a configured instance of a runtime component type and version. A runtime instance is composed of multiple runtime components.

This interface is not intended to be implemented outside of this framework. Client code can get access to IRuntimeComponent objects by using methods on the IRuntime and RuntimeManager classes.

Author:
Konstantin Komissarchik
See Also:
IRuntime.getRuntimeComponents(), RuntimeManager.createRuntimeComponent(IRuntimeComponentVersion,Map)

Method Summary
 Map<String,String> getProperties()
          Returns the properties associated with this runtime component.
 String getProperty(String name)
          Returns the value of the specified property.
 IRuntime getRuntime()
          Returns the runtime that this component belongs to or null if this component has not yet been associated with a runtime.
 IRuntimeComponentType getRuntimeComponentType()
          Returns the runtime component type that this is an instance of.
 IRuntimeComponentVersion getRuntimeComponentVersion()
          Returns the runtime component version that this is an instance of.
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getRuntimeComponentType

IRuntimeComponentType getRuntimeComponentType()
Returns the runtime component type that this is an instance of.

Returns:
the runtime component type that this is an instance of

getRuntimeComponentVersion

IRuntimeComponentVersion getRuntimeComponentVersion()
Returns the runtime component version that this is an instance of.

Returns:
the runtime component version that this is an instance of

getRuntime

IRuntime getRuntime()
Returns the runtime that this component belongs to or null if this component has not yet been associated with a runtime.

Returns:
the runtime that that this component belongs to

getProperties

Map<String,String> getProperties()
Returns the properties associated with this runtime component. The contents will vary dependending on the component type/version, but usually this will at least contain the path to the location on disk where the runtime is installed.

Returns:
the properties associated with this runtime component

getProperty

String getProperty(String name)
Returns the value of the specified property.

Parameters:
name - the property name
Returns:
the property value, or null

Faceted Project Framework
Version 1.3

Copyright (c) 2008 BEA Systems, Inc. and others. All rights reserved.