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

All Known Implementing Classes:

NullDefaultJavaAttributeMappingDefinition, NullSpecifiedJavaAttributeMappingDefinition

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:

2.3

Version:

2.3

Method Summary

JavaAttributeMapping	buildMapping(JavaPersistentAttribute attribute, JpaFactory factory) Build a Java attribute mapping for the specified attribute.
java.lang.String	getAnnotationName() Return the attribute mapping's Java annotation name.
java.lang.String	getKey() Return the attribute mapping's key.
boolean	testDefault(JavaPersistentAttribute persistentAttribute) Return whether this mapping provider should be used for the given JavaPersistentAttribute in the default (ignoring all mapping annotations) case.
boolean	testSpecified(JavaPersistentAttribute persistentAttribute) Return whether this mapping provider should be used for the given JavaPersistentAttribute in the specified (observing all mapping annotations) case.

Method Detail

getKey

java.lang.String getKey()

Return the attribute mapping's key.

getAnnotationName

java.lang.String getAnnotationName()

Return the attribute mapping's Java annotation name.

buildMapping

JavaAttributeMapping buildMapping(JavaPersistentAttribute attribute,
                                  JpaFactory 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.

testDefault

boolean testDefault(JavaPersistentAttribute persistentAttribute)

Return whether this mapping provider should be used for the given JavaPersistentAttribute in the default (ignoring all mapping annotations) case.

testSpecified

boolean testSpecified(JavaPersistentAttribute persistentAttribute)

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