StructMetadata

java.lang.Object
- org.eclipse.persistence.internal.jpa.metadata.ORMetadata
- - org.eclipse.persistence.internal.jpa.metadata.structures.StructMetadata

```
public class StructMetadata
extends ORMetadata
```
Defines the metadata for the @Struct annotation for mapping ObjectRelationshipDataTypeDescriptor. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - any metadata mapped from XML to this class must be initialized in the initXMLObject 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.3

Author:

James Sutherland

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

Constructor Summary

Constructors
Constructor	Description
`StructMetadata()`	INTERNAL: Used for XML loading.
`StructMetadata(MetadataAnnotation struct, MetadataAccessor accessor)`	INTERNAL: Used for annotation loading.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object objectToCompare)`	INTERNAL: Used for xml merging.
`java.util.List<java.lang.String>`	`getFields()`	INTERNAL: Used for OX mapping.
`java.lang.String`	`getName()`	INTERNAL: Used for OX mapping.
`int`	`hashCode()`
`void`	`process(MetadataDescriptor descriptor)`	INTERNAL: Switch the descriptor to the correct type and set the structure name and properties.
`void`	`setFields(java.util.List<java.lang.String> fields)`	INTERNAL: Used for OX mapping.
`void`	`setName(java.lang.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
  - StructMetadata
```
public StructMetadata()
```
    INTERNAL: Used for XML loading.
  - StructMetadata
```
public StructMetadata(MetadataAnnotation struct,
                      MetadataAccessor accessor)
```
    INTERNAL: Used for annotation loading.
- Method Detail
  - equals
```
public boolean equals(java.lang.Object objectToCompare)
```
    INTERNAL: Used for xml merging.
    
    Specified by:
    
    equals in class ORMetadata
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - process
```
public void process(MetadataDescriptor descriptor)
```
    INTERNAL: Switch the descriptor to the correct type and set the structure name and properties.
  - getFields
```
public java.util.List<java.lang.String> getFields()
```
    INTERNAL: Used for OX mapping.
  - getName
```
public java.lang.String getName()
```
    INTERNAL: Used for OX mapping.
  - setFields
```
public void setFields(java.util.List<java.lang.String> fields)
```
    INTERNAL: Used for OX mapping.
  - setName
```
public void setName(java.lang.String name)
```
    INTERNAL: Used for OX mapping.