|
Faceted Project Framework Version 1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRuntime
Represents a configured instance of a runtime. 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 IRuntime
objects by using methods on the RuntimeManager
class.
RuntimeManager.getRuntimes()
,
RuntimeManager.getRuntime(String)
,
RuntimeManager.isRuntimeDefined(String)
,
RuntimeManager.defineRuntime(String,List,Map)
Method Summary | |
---|---|
Set<String> |
getAlternateNames()
Returns the set of other names (if any) that this runtime may be known by. |
Set<IProjectFacetVersion> |
getDefaultFacets(Set<IProjectFacet> fixed)
Deprecated. use IFacetedProjectWorkingCopy.getDefaultConfiguration() instead |
String |
getLocalizedName()
Returns the localized name of this runtime. |
String |
getName()
Returns the name of this runtime. |
Map<String,String> |
getProperties()
Returns the properties associated with this runtime component. |
String |
getProperty(String name)
Returns the value of the specified property. |
List<IRuntimeComponent> |
getRuntimeComponents()
Returns the runtime components that comprise this runtime. |
boolean |
supports(IProjectFacet f)
|
boolean |
supports(IProjectFacetVersion fv)
Determines whether this runtime supports the specified project facet. |
IStatus |
validate(IProgressMonitor monitor)
Performs a number of runtime-specific checks to determine whether this runtime instance is valid or not. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Method Detail |
---|
String getName()
String getLocalizedName()
getName()
method.
The localized name should be used in all communications with the user while all metadata references to the runtime should use the unlocalized name. Note that there is an inherent danger in this. If a runtime is deleted or renamed, existing projects that use that runtime might become invalid. In that case the system will need to communicate that problem to the user using the unlocalized name for the runtime. Since the user is never exposed to runtime's unlocalized name, the user can have trouble understanding and correcting the problem. A similar situation can arise when a project is imported into another user's workspace.
To mitigate the above risks, the name localization feature is expected to be used sparingly and only in contexts where the runtime provider can take steps to guarantee that the above situation is not likely to occur. One scenario where name localization is acceptable is when a runtime is auto-created and the user is not given ability to delete or rename it.
Set<String> getAlternateNames()
List<IRuntimeComponent> getRuntimeComponents()
Map<String,String> getProperties()
String getProperty(String name)
name
- the property name
null
boolean supports(IProjectFacetVersion fv)
org.eclipse.wst.common.project.facet.core.runtime
extension
point.
fv
- the project facet version
true
if this runtime supports the specified facet,
false
otherwiseboolean supports(IProjectFacet f)
Set<IProjectFacetVersion> getDefaultFacets(Set<IProjectFacet> fixed) throws CoreException
org.eclipse.wst.common.project.facet.core.defaultFacets
extension point. The returned list is filtered by removing facets that
would conflict with the specified fixed facets. Note that the returned
set will always include the fixed facets. If the default version for any
fixed facet is not explicitly specified through the above extension
point, the latest version will be used.
fixed
- the fixed facets
CoreException
- if failed for any reasonIStatus validate(IProgressMonitor monitor)
monitor
- used for getting progress information and canceling validation
|
Faceted Project Framework Version 1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |