org.eclipse.jpt.jaxb.core.context.java
Interface JavaAttributeMappingDefinition

All Known Subinterfaces:

DefaultJavaAttributeMappingDefinition

public interface JavaAttributeMappingDefinition

Map a string key to an attribute mapping and its corresponding Java annotation. 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

Method Summary

JaxbAttributeMapping	buildMapping(JaxbPersistentAttribute attribute, JaxbFactory factory) Build a Java attribute mapping for the specified attribute.
String	getAnnotationName() Return the attribute mapping's Java annotation name.
String	getKey() Return the attribute mapping's key.
Iterable<String>	getSupportingAnnotationNames() Return all fully qualified annotation names that are supported with this mapping type.
boolean	isSpecified(JaxbPersistentAttribute persistentAttribute) Return whether this mapping provider should be used for the given PersistentAttribute in the specified (observing all mapping annotations) case.

Method Detail

getKey

String getKey()

Return the attribute mapping's key.

getAnnotationName

String getAnnotationName()

Return the attribute mapping's Java annotation name.

buildMapping

JaxbAttributeMapping buildMapping(JaxbPersistentAttribute attribute,
                                  JaxbFactory factory)

Build a Java attribute mapping for the specified attribute. Use the specified factory for creation so extenders can simply override the appropriate creation method instead of building a provider for the same key.

getSupportingAnnotationNames

Iterable<String> getSupportingAnnotationNames()

Return all fully qualified annotation names that are supported with this mapping type. This includes all possible annotations, not just the ones that currently exist on the attribute.

isSpecified

boolean isSpecified(JaxbPersistentAttribute persistentAttribute)

Return whether this mapping provider should be used for the given PersistentAttribute in the specified (observing all mapping annotations) case.