UniqueKeyConstraint (EclipseLink 4.0.9, API Reference)

java.lang.Object
- org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
- - org.eclipse.persistence.tools.schemaframework.ConstraintObjectDefinition
  - - org.eclipse.persistence.tools.schemaframework.UniqueKeyConstraint

All Implemented Interfaces:

Serializable, Cloneable
```
public class UniqueKeyConstraint
extends ConstraintObjectDefinition
```
Purpose: Define a unique key constraint for a table.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
  name, qualifier

Constructor Summary

Constructors
Constructor	Description
`UniqueKeyConstraint()`
`UniqueKeyConstraint(String name, String sourceField)`
`UniqueKeyConstraint(String name, String[] sourceFields)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addSourceField(String sourceField)`
`void`	`appendDBString(Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session)`	Deprecated, for removal: This API element is subject to removal in a future version.
`protected void`	`appendKeys(Writer writer, List<String> keys)`	Deprecated, for removal: This API element is subject to removal in a future version.
`List<String>`	`getSourceFields()`
`void`	`setSourceFields(List<String> sourceFields)`

Methods inherited from class org.eclipse.persistence.tools.schemaframework.ConstraintObjectDefinition
buildCreationWriter, buildDeletionWriter, getOptions, setOptions

Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, createOnDatabase, dropDatabaseSchema, dropDatabaseSchemaOnDatabase, dropFromDatabase, dropObject, getDatabaseSchema, getFieldTypeDefinition, getFieldTypeDefinition, getFullName, getName, getQualifier, hasDatabaseSchema, postCreateObject, preDropObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UniqueKeyConstraint
```
public UniqueKeyConstraint()
```

UniqueKeyConstraint

public UniqueKeyConstraint(String name,
                           String sourceField)

UniqueKeyConstraint

public UniqueKeyConstraint(String name,
                           String[] sourceFields)

Method Detail

appendDBString
```
@Deprecated(forRemoval=true,
            since="4.0.9")
public void appendDBString(Writer writer,
                           org.eclipse.persistence.internal.sessions.AbstractSession session)
```
Deprecated, for removal: This API element is subject to removal in a future version.

INTERNAL: Append the database field definition string to the table creation statement.

Overrides:

appendDBString in class ConstraintObjectDefinition

appendKeys

@Deprecated(forRemoval=true,
            since="4.0.9")
protected void appendKeys(Writer writer,
                          List<String> keys)

Deprecated, for removal: This API element is subject to removal in a future version.

addSourceField

public void addSourceField(String sourceField)

getSourceFields
```
public List<String> getSourceFields()
```

setSourceFields

public void setSourceFields(List<String> sourceFields)