IDBIndex.Type (Net4j DB Framework Documentation)

Overview

Package

Class

Use

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.eclipse.net4j.db.ddl
Enum IDBIndex.Type

java.lang.Object
  java.lang.Enum<IDBIndex.Type>
      org.eclipse.net4j.db.ddl.IDBIndex.Type

All Implemented Interfaces:: Serializable, Comparable<IDBIndex.Type>

Enclosing interface:: IDBIndex

public static enum IDBIndex.Type: extends Enum<IDBIndex.Type>

The type of an index specification in a DB table.

No Extend: This interface is not intended to be extended by clients.

Enum Constant Summary
`NON_UNIQUE`
`PRIMARY_KEY`
`UNIQUE`

Method Summary
`static IDBIndex.Type`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static IDBIndex.Type[]`	`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

PRIMARY_KEY

public static final IDBIndex.Type PRIMARY_KEY

UNIQUE

public static final IDBIndex.Type UNIQUE

NON_UNIQUE

public static final IDBIndex.Type NON_UNIQUE

Method Detail

values

public static IDBIndex.Type[] 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 (IDBIndex.Type c : IDBIndex.Type.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static IDBIndex.Type 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