SurrogateColumnType (DataNucleus Core 5.2.3 API)

java.lang.Object
- java.lang.Enum<SurrogateColumnType>
- - org.datanucleus.store.schema.table.SurrogateColumnType

All Implemented Interfaces:

Serializable, Comparable<SurrogateColumnType>
```
public enum SurrogateColumnType
extends Enum<SurrogateColumnType>
```
Enum defining the types of surrogate columns for a class. The
```
fieldNumber
```
is used where we need to pass a list of fields to be fetched, or updated, and want to include surrogate fields. The normal fields of a class are numbered from 0 upwards, so we use negative numbers for the surrogates.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CREATE_TIMESTAMP`
`CREATE_USER`
`DATASTORE_ID`
`DISCRIMINATOR`
`MULTITENANCY`
`SOFTDELETE`
`UPDATE_TIMESTAMP`
`UPDATE_USER`
`VERSION`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getFieldNumber()`
`static SurrogateColumnType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SurrogateColumnType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - DATASTORE_ID
```
public static final SurrogateColumnType DATASTORE_ID
```
  - VERSION
```
public static final SurrogateColumnType VERSION
```
  - DISCRIMINATOR
```
public static final SurrogateColumnType DISCRIMINATOR
```
  - MULTITENANCY
```
public static final SurrogateColumnType MULTITENANCY
```
  - CREATE_TIMESTAMP
```
public static final SurrogateColumnType CREATE_TIMESTAMP
```
  - UPDATE_TIMESTAMP
```
public static final SurrogateColumnType UPDATE_TIMESTAMP
```
  - SOFTDELETE
```
public static final SurrogateColumnType SOFTDELETE
```
  - CREATE_USER
```
public static final SurrogateColumnType CREATE_USER
```
  - UPDATE_USER
```
public static final SurrogateColumnType UPDATE_USER
```
- Method Detail
  - values
```
public static SurrogateColumnType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SurrogateColumnType c : SurrogateColumnType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SurrogateColumnType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getFieldNumber
```
public int getFieldNumber()
```

Enum SurrogateColumnType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DATASTORE_ID

VERSION

DISCRIMINATOR

MULTITENANCY

CREATE_TIMESTAMP

UPDATE_TIMESTAMP

SOFTDELETE

CREATE_USER

UPDATE_USER

Method Detail

values

valueOf

getFieldNumber