org.eclipse.jpt.jpa.core.context.java
Interface JavaTypeMappingDefinition


public interface JavaTypeMappingDefinition

Map a string key to a type mapping and its corresponding Java annotations.

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:
2.3
Version:
2.3

Method Summary
 JavaTypeMapping buildMapping(JavaPersistentType persistentType, Annotation annotation, JpaFactory factory)
          Build a Java type mapping for the specified persistent type and annotation.
 java.lang.String getAnnotationName()
          Return the name of the type mapping's annotation.
 java.lang.String getKey()
          Return the type mapping's key.
 java.lang.Iterable<java.lang.String> getSupportingAnnotationNames()
          Return the names of the type mapping's "supporting" annotations.
 

Method Detail

getKey

java.lang.String getKey()
Return the type mapping's key.


getAnnotationName

java.lang.String getAnnotationName()
Return the name of the type mapping's annotation.


getSupportingAnnotationNames

java.lang.Iterable<java.lang.String> getSupportingAnnotationNames()
Return the names of the type mapping's "supporting" annotations.


buildMapping

JavaTypeMapping buildMapping(JavaPersistentType persistentType,
                             Annotation annotation,
                             JpaFactory factory)
Build a Java type mapping for the specified persistent type and annotation. Use the specified factory for creation so extenders can simply override the appropriate factory method instead of building a definition for the same key.