MapKeyMetadata (EclipseLink JPA 4.0.6 API)

java.lang.Object
- org.eclipse.persistence.internal.jpa.metadata.ORMetadata
- - org.eclipse.persistence.internal.jpa.metadata.mappings.MapKeyMetadata

```
public class MapKeyMetadata
extends ORMetadata
```
Object to hold onto map key metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.

Since:

EclipseLink 2.0

Author:

Guy Pelletier

Field Summary
- Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
  m_project

Constructor Summary

Constructors
Constructor	Description
`MapKeyMetadata()`	INTERNAL: Used for XML loading.
`MapKeyMetadata(MetadataAccessor accessor)`	INTERNAL: Used for defaulting.
`MapKeyMetadata(MetadataAnnotation mapKey, MetadataAccessor accessor)`	INTERNAL: Used for annotation loading.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object objectToCompare)`	INTERNAL:
`String`	`getName()`	INTERNAL: Used for OX mapping.
`int`	`hashCode()`
`boolean`	`hasName()`	INTERNAL: Return true if a name has been specified.
`String`	`process(ContainerMapping mapping, MappingAccessor mappingAccessor)`	INTERNAL: Process a map key for a 1-M or M-M mapping.
`void`	`setName(String name)`	INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata
getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapKeyMetadata
```
public MapKeyMetadata()
```
    INTERNAL: Used for XML loading.
  - MapKeyMetadata
```
public MapKeyMetadata(MetadataAccessor accessor)
```
    INTERNAL: Used for defaulting.
  - MapKeyMetadata
```
public MapKeyMetadata(MetadataAnnotation mapKey,
                      MetadataAccessor accessor)
```
    INTERNAL: Used for annotation loading.
- Method Detail
  - equals
```
public boolean equals(Object objectToCompare)
```
    INTERNAL:
    
    Specified by:
    
    equals in class ORMetadata
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - hasName
```
public boolean hasName()
```
    INTERNAL: Return true if a name has been specified.
  - process
```
public String process(ContainerMapping mapping,
                      MappingAccessor mappingAccessor)
```
    INTERNAL: Process a map key for a 1-M or M-M mapping. Will return the map key method name that should be use, null otherwise.
  - getName
```
public String getName()
```
    INTERNAL: Used for OX mapping.
  - setName
```
public void setName(String name)
```
    INTERNAL: Used for OX mapping.