org.eclipse.jpt.jaxb.core.platform
Interface JaxbPlatformConfig

public interface JaxbPlatformConfig

Metadata that describes a JAXB platform as defined in an extension to the org.eclipse.jpt.jaxb.core.jaxbPlatforms extension point.

See org.eclipse.jpt.jaxb.core/plugin.xml:jaxbPlatforms.

Not intended to be implemented by clients.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

3.0

Nested Class Summary

static class	JaxbPlatformConfig.IsDefault
static class	JaxbPlatformConfig.SupportsJaxbFacetVersion

Field Summary

static org.eclipse.jpt.common.utility.predicate.Predicate<JaxbPlatformConfig>

IS_DEFAULT

Method Summary

String	getFactoryClassName() Return the config's extension-supplied factory class name.
JaxbPlatformGroupConfig	getGroupConfig() Return config's group config.
String	getId() Return the config's extension-supplied ID.
JaxbPlatformManager	getJaxbPlatformManager() 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 JAXB platform config.
boolean	isDefault() Return whether the config's JAXB platform can be used as the default JAXB platform for its supported JAXB facet versions.
boolean	supportsJaxbFacetVersion(IProjectFacetVersion jaxbFacetVersion) Return whether the config's JAXB platform supports the specified JAXB facet version.

Field Detail

IS_DEFAULT

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

Method Detail

getJaxbPlatformManager

JaxbPlatformManager getJaxbPlatformManager()

Return the config's manager.

getId

String getId()

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

getLabel

String getLabel()

Return the config's extension-supplied label.

getFactoryClassName

String getFactoryClassName()

Return the config's extension-supplied factory class name. The class must be instantiable and implement the JaxbPlatformDefinitionFactory interface.

supportsJaxbFacetVersion

boolean supportsJaxbFacetVersion(IProjectFacetVersion jaxbFacetVersion)

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

Throws:

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

isDefault

boolean isDefault()

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

getGroupConfig

JaxbPlatformGroupConfig getGroupConfig()

Return config's group config.

getPluginId

String getPluginId()

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