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

public interface JaxbPlatform

Provisional API: This class 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

Version:

3.0

Method Summary

JaxbFile	buildJaxbFile(JaxbProject jaxbProject, org.eclipse.core.resources.IFile file) Return a JAXB file corresponding to the specified Eclipse file.
AnnotationEditFormatter	getAnnotationEditFormatter() Return a formatter that can clean up the Java annotations added to source code.
AnnotationProvider	getAnnotationProvider() Return an annotation provider responsible for determining what Java annotations are supported and constructing java resource model objects.
java.lang.Iterable<DefaultJavaAttributeMappingDefinition>	getDefaultJavaAttributeMappingDefinitions()
JaxbPlatformDescription	getDescription()
JaxbFactory	getFactory() Return a factory responsible for creating core (e.g.
JavaAttributeMappingDefinition	getSpecifiedJavaAttributeMappingDefinition(JaxbPersistentAttribute attribute) Return a JavaAttributeMappingDefinition that describes the interpretation of the attribute as it exists, complete with annotations.
JavaAttributeMappingDefinition	getSpecifiedJavaAttributeMappingDefinition(java.lang.String mappingKey) Return a JavaAttributeMappingDefinition for the given mapping key.
java.lang.Iterable<JavaAttributeMappingDefinition>	getSpecifiedJavaAttributeMappingDefinitions()

Method Detail

getDescription

JaxbPlatformDescription getDescription()

getFactory

JaxbFactory getFactory()

Return a factory responsible for creating core (e.g. JaxbProject), resource (e.g. PersistenceResource), and context (e.g. PersistenceUnit) model objects

buildJaxbFile

JaxbFile buildJaxbFile(JaxbProject jaxbProject,
                       org.eclipse.core.resources.IFile file)

Return a JAXB file corresponding to the specified Eclipse file. Return null if the file's content is unsupported.

getAnnotationProvider

AnnotationProvider getAnnotationProvider()

Return an annotation provider responsible for determining what Java annotations are supported and constructing java resource model objects.

getAnnotationEditFormatter

AnnotationEditFormatter getAnnotationEditFormatter()

Return a formatter that can clean up the Java annotations added to source code.

getSpecifiedJavaAttributeMappingDefinitions

java.lang.Iterable<JavaAttributeMappingDefinition> getSpecifiedJavaAttributeMappingDefinitions()

getDefaultJavaAttributeMappingDefinitions

java.lang.Iterable<DefaultJavaAttributeMappingDefinition> getDefaultJavaAttributeMappingDefinitions()

getSpecifiedJavaAttributeMappingDefinition

JavaAttributeMappingDefinition getSpecifiedJavaAttributeMappingDefinition(JaxbPersistentAttribute attribute)

Return a JavaAttributeMappingDefinition that describes the interpretation of the attribute as it exists, complete with annotations. It is assumed that the attribute's default mapping has already been determined. This may not be null (@see NullSpecifiedJavaAttributeMappingDefinition,) else an IllegalStateException is thrown.

Parameters:

attribute - The persistent attribute to analyze

Returns:

The mapping definition describing the annotated state of the attribute

getSpecifiedJavaAttributeMappingDefinition

JavaAttributeMappingDefinition getSpecifiedJavaAttributeMappingDefinition(java.lang.String mappingKey)

Return a JavaAttributeMappingDefinition for the given mapping key. Throw an IllegalArgumentException if the key is not supported by the platform.