Faceted Project Framework
Version 1.3

org.eclipse.wst.common.project.facet.core
Interface IPreset

All Known Subinterfaces:
IDynamicPreset

public interface IPreset

A preset is a user convenience mechanism for quickly selecting a predefined set of project facets. Presets can be defined by plugin writers through the supplied presets extension point as well as by end users. User-defined presets are stored in the workspace.

Author:
Konstantin Komissarchik

Nested Class Summary
static class IPreset.Type
          The enumberation of preset types.
 
Method Summary
 String getDescription()
          Returns the description of the preset.
 String getId()
          Returns the id of the preset.
 String getLabel()
          Returns the label that should be used when presenting the preset to the user.
 Set<IProjectFacetVersion> getProjectFacets()
          Returns the project facets that are part of this preset.
 IPreset.Type getType()
          Returns the type of the preset.
 boolean isUserDefined()
          Deprecated. use the getType() method instead
 

Method Detail

getId

String getId()
Returns the id of the preset.

Returns:
the id of the preset

getType

IPreset.Type getType()
Returns the type of the preset. If the preset type is IPreset.Type.DYNAMIC, then the preset object can be cast to IDynamicPreset.

Returns:
the type of the preset
Since:
2.0

getLabel

String getLabel()
Returns the label that should be used when presenting the preset to the user.

Returns:
the preset label

getDescription

String getDescription()
Returns the description of the preset.

Returns:
the description of the preset

getProjectFacets

Set<IProjectFacetVersion> getProjectFacets()
Returns the project facets that are part of this preset.

Returns:
project facets that are part of this preset

isUserDefined

boolean isUserDefined()
Deprecated. use the getType() method instead

Indicates whether the preset is user defined. A user-defined preset is stored in the workspace and can be deleted.

Returns:
true if the preset is user-defined, false otherwise

Faceted Project Framework
Version 1.3

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