org.eclipse.jpt.jpa.core
Interface JpaPlatform.Config

Enclosing interface:

JpaPlatform

public static interface JpaPlatform.Config

Metadata that describes a JPA platform as defined in an extension to the org.eclipse.jpt.jpa.core.jpaPlatforms extension point.

See org.eclipse.jpt.jpa.core/plugin.xml:jpaPlatforms.

Not intended to be implemented by clients.

Nested Class Summary

static class

JpaPlatform.Config.IsDefault

Field Summary

static org.eclipse.jpt.common.utility.predicate.Predicate<JpaPlatform.Config>

IS_DEFAULT

Method Summary

JpaPlatform.GroupConfig	getGroupConfig() Return config's group config.
String	getId() Return the config's extension-supplied ID.
IProjectFacetVersion	getJpaFacetVersion() Return the config's JPA facet version or null if the extension does not specify a JPA facet version.
JpaPlatform	getJpaPlatform() Build and return the config's JPA platform.
JpaPlatformManager	getJpaPlatformManager() Return the config's manager.
String	getLabel() Return the config's extension-supplied label.
String	getPluginId() Return the ID of the plug-in that contributed the JPA platform config.
boolean	isDefault() Return whether the config's JPA platform can be used as the default JPA platform for its supported JPA facet versions.
boolean	supportsJpaFacetVersion(IProjectFacetVersion jpaFacetVersion) Return whether the config's JPA platform supports the specified JPA facet version.

Field Detail

IS_DEFAULT

static final org.eclipse.jpt.common.utility.predicate.Predicate<JpaPlatform.Config> IS_DEFAULT

Method Detail

getJpaPlatformManager

JpaPlatformManager getJpaPlatformManager()

Return the config's manager.

getId

String getId()

Return the config's extension-supplied ID. This is unique among all the JPA platform configs.

getLabel

String getLabel()

Return the config's extension-supplied label.

getJpaFacetVersion

IProjectFacetVersion getJpaFacetVersion()

Return the config's JPA facet version or null if the extension does not specify a JPA facet version.

supportsJpaFacetVersion

boolean supportsJpaFacetVersion(IProjectFacetVersion jpaFacetVersion)

Return whether the config's JPA platform supports the specified JPA facet version. If the extension specifies a JPA facet version, it must be the same as the specified JPA facet version. If the extension does not specify a JPA facet version, the config's JPA platform supports all JPA facet versions.

Throws:

IllegalArgumentException - if the specified facet version is not for a JPA facet

isDefault

boolean isDefault()

Return whether the config's JPA platform can be used as the default JPA platform for its supported JPA facet versions.

getGroupConfig

JpaPlatform.GroupConfig getGroupConfig()

Return config's group config.

getPluginId

String getPluginId()

Return the ID of the plug-in that contributed the JPA platform config.

getJpaPlatform

JpaPlatform getJpaPlatform()

Build and return the config's JPA platform.