Module org.postgresql.pljava

Package org.postgresql.pljava.annotation

Enum BaseUDT.PredefinedCategory

java.lang.Object

java.lang.Enum<BaseUDT.PredefinedCategory>

org.postgresql.pljava.annotation.BaseUDT.PredefinedCategory

All Implemented Interfaces:

Serializable, Comparable<BaseUDT.PredefinedCategory>, Constable

Enclosing class:

BaseUDT

public static enum BaseUDT.PredefinedCategory
extends Enum<BaseUDT.PredefinedCategory>

The type categories that are predefined in PostgreSQL.

This enumeration is not used as the type of the category element below, because PostgreSQL allows use of other single-ASCII-character category codes for custom purposes. Therefore, the annotation can be any such character. PostgreSQL reserves all of the upper-case ASCII letters to represent current or future predefined categories, and this enumeration allows mapping between those and their more readable names.

When one of the predefined categories is wanted for the category element, the corresponding character constant in PredefinedCategory.Code can be used in the annotation as a more readable alternative to the one-character code.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseUDT.PredefinedCategory.Code	Character constants corresponding to the predefined categories, for use in the BaseUDT.category() annotation element.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRAY
BITSTRING
BOOLEAN
COMPOSITE
DATETIME
ENUM
GEOMETRIC
INTERNAL
NETWORK
NUMERIC
PSEUDOTYPE
RANGE
STRING
TIMESPAN
UNKNOWN
USER

Method Summary

Modifier and Type	Method	Description
char	code()	Return this category's single-character code.
static BaseUDT.PredefinedCategory	valueOf(char code)	Return the PredefinedCategory corresponding to a single-character code as found in the system catalogs, or null if the character represents a custom category (or a predefined one in a PostgreSQL version newer than this class).
static BaseUDT.PredefinedCategory	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BaseUDT.PredefinedCategory[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ARRAY

public static final BaseUDT.PredefinedCategory ARRAY

BOOLEAN

public static final BaseUDT.PredefinedCategory BOOLEAN

COMPOSITE

public static final BaseUDT.PredefinedCategory COMPOSITE

DATETIME

public static final BaseUDT.PredefinedCategory DATETIME

ENUM

public static final BaseUDT.PredefinedCategory ENUM

GEOMETRIC

public static final BaseUDT.PredefinedCategory GEOMETRIC

NETWORK

public static final BaseUDT.PredefinedCategory NETWORK

NUMERIC

public static final BaseUDT.PredefinedCategory NUMERIC

PSEUDOTYPE

public static final BaseUDT.PredefinedCategory PSEUDOTYPE

RANGE

public static final BaseUDT.PredefinedCategory RANGE

STRING

public static final BaseUDT.PredefinedCategory STRING

TIMESPAN

public static final BaseUDT.PredefinedCategory TIMESPAN

USER

public static final BaseUDT.PredefinedCategory USER

BITSTRING

public static final BaseUDT.PredefinedCategory BITSTRING

UNKNOWN

public static final BaseUDT.PredefinedCategory UNKNOWN

INTERNAL

public static final BaseUDT.PredefinedCategory INTERNAL

Method Detail

values

public static BaseUDT.PredefinedCategory[] values()

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

Returns:

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

valueOf

public static BaseUDT.PredefinedCategory 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

code

public char code()

Return this category's single-character code.

valueOf

public static BaseUDT.PredefinedCategory valueOf(char code)

Return the PredefinedCategory corresponding to a single-character code as found in the system catalogs, or null if the character represents a custom category (or a predefined one in a PostgreSQL version newer than this class).