Package com.intellij.facet

Class FacetType<F extends Facet,C extends FacetConfiguration>

java.lang.Object

com.intellij.facet.FacetType<F,C>

All Implemented Interfaces:

PluginAware

Direct Known Subclasses:

AppEngineFacetType, BuildoutFacetType, InvalidFacetType

public abstract class FacetType<F extends Facet,C extends FacetConfiguration>
extends java.lang.Object
implements PluginAware

Override this class to provide custom type of facets. The implementation should be registered in your plugin.xml:

 <extensions defaultExtensionNs="com.intellij">
   <facetType implementation="qualified-class-name"/>
 </extensions>
 

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<FacetType>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
FacetType(FacetTypeId<F> id, java.lang.String stringId, java.lang.String presentableName)
FacetType(FacetTypeId<F> id, java.lang.String stringId, java.lang.String presentableName, FacetTypeId underlyingFacetType)

Method Summary

Modifier and Type	Method and Description
abstract C	createDefaultConfiguration() Create default configuration of facet.
DefaultFacetSettingsEditor	createDefaultConfigurationEditor(Project project, C configuration)
abstract F	createFacet(Module module, java.lang.String name, C configuration, Facet underlyingFacet) Create a new facet instance.
MultipleFacetSettingsEditor	createMultipleConfigurationsEditor(Project project, FacetEditor [] editors) Override to allow editing several facets at once.
static <T extends FacetType> T	findInstance(java.lang.Class<T> aClass)
java.lang.String	getDefaultFacetName() Default name which will be used then user creates a facet of this type.
java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for this facet type is requested.
javax.swing.Icon	getIcon()
FacetTypeId<F>	getId()
PluginDescriptor	getPluginDescriptor()
java.lang.String	getPresentableName()
java.lang.String	getStringId()
FacetTypeId<?>	getUnderlyingFacetType()
boolean	isOnlyOneFacetAllowed()
abstract boolean	isSuitableModuleType(ModuleType moduleType)
void	registerDetectors(FacetDetectorRegistry<C> registry) Deprecated. this method is not called by IDE core anymore. Use FrameworkDetector extension to provide automatic detection for facets
void	setPluginDescriptor(PluginDescriptor pluginDescriptor) Called by extensions framework when extension is loaded from plugin.xml descriptor.

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<FacetType> EP_NAME

Constructor Detail

FacetType

public FacetType(FacetTypeId<F> id,
                 java.lang.String stringId,
                 java.lang.String presentableName,
                 FacetTypeId underlyingFacetType)

Parameters:

id - unique instance of FacetTypeId

stringId - unique string id of the facet type

presentableName - name of this facet type which will be shown in UI

underlyingFacetType - if this parameter is not null then you will be able to add facets of this type only as subfacets to a facet of the specified type. If this parameter is null it will be possible to add facet of this type directly to a module

FacetType

public FacetType(FacetTypeId<F> id,
                 java.lang.String stringId,
                 java.lang.String presentableName)

Parameters:

id - unique instance of FacetTypeId

stringId - unique string id of the facet type

presentableName - name of this facet type which will be shown in UI

Method Detail

findInstance

public static <T extends FacetType> T findInstance(java.lang.Class<T> aClass)

getId

public final FacetTypeId<F> getId()

getStringId

public final java.lang.String getStringId()

getPresentableName

public java.lang.String getPresentableName()

getDefaultFacetName

public java.lang.String getDefaultFacetName()

Default name which will be used then user creates a facet of this type.

getUnderlyingFacetType

public FacetTypeId<?> getUnderlyingFacetType()

setPluginDescriptor

public void setPluginDescriptor(PluginDescriptor pluginDescriptor)

Description copied from interface: PluginAware

Called by extensions framework when extension is loaded from plugin.xml descriptor.

If this method is implemented in a bean class extension point and it also exposes the stored plugin description via getPluginDescriptor method, you must annotate the latter with @Transient to ensure that serialization engine won't try to deserialize this property.

Specified by:

setPluginDescriptor in interface PluginAware

Parameters:

pluginDescriptor - descriptor of the plugin that provided this particular extension.

getPluginDescriptor

public final PluginDescriptor getPluginDescriptor()

registerDetectors

@Deprecated
public void registerDetectors(FacetDetectorRegistry<C> registry)

Deprecated. this method is not called by IDE core anymore. Use FrameworkDetector extension to provide automatic detection for facets

createDefaultConfiguration

public abstract C createDefaultConfiguration()

Create default configuration of facet. See FacetConfiguration for details.

createFacet

public abstract F createFacet(Module module,
                              java.lang.String name,
                              C configuration,
                              Facet underlyingFacet)

Create a new facet instance.

Parameters:

module - parent module for facet. Must be passed to Facet constructor

name - name of facet. Must be passed to Facet constructor

configuration - facet configuration. Must be passed to Facet constructor

underlyingFacet - underlying facet. Must be passed to Facet constructor

Returns:

a created facet

isOnlyOneFacetAllowed

public boolean isOnlyOneFacetAllowed()

Returns:

true if only one facet of this type is allowed within the containing module (if this type doesn't have the underlying facet type) or within the underlying facet

isSuitableModuleType

public abstract boolean isSuitableModuleType(ModuleType moduleType)

Parameters:

moduleType - type of module

Returns:

true if facet of this type are allowed in module of type moduleType

getIcon

public javax.swing.Icon getIcon()

getHelpTopic

public java.lang.String getHelpTopic()

Returns the topic in the help file which is shown when help for this facet type is requested.

Returns:

the help topic, or null if no help is available.

createDefaultConfigurationEditor

public DefaultFacetSettingsEditor createDefaultConfigurationEditor(Project project,
                                                                   C configuration)

createMultipleConfigurationsEditor

public MultipleFacetSettingsEditor createMultipleConfigurationsEditor(Project project,
                                                                      FacetEditor [] editors)

Override to allow editing several facets at once.

Parameters:

project - project

editors - editors of selected facets

Returns:

editor