schemacrawler.schema

Enum FunctionReturnType

java.lang.Object

java.lang.Enum<FunctionReturnType>

schemacrawler.schema.FunctionReturnType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FunctionReturnType>, RoutineReturnType, IdentifiedEnum

public enum FunctionReturnType
extends java.lang.Enum<FunctionReturnType>
implements RoutineReturnType

An enumeration wrapper around JDBC function types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
noTable Does not return a table.
returnsTable Returns a table.
unknown Result unknown.

Method Summary

Modifier and Type	Method and Description
int	getId() Gets the id.
java.lang.String	toString()
static FunctionReturnType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FunctionReturnType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

unknown

public static final FunctionReturnType unknown

Result unknown.

noTable

public static final FunctionReturnType noTable

Does not return a table.

returnsTable

public static final FunctionReturnType returnsTable

Returns a table.

Method Detail

values

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

Returns:

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

valueOf

public static FunctionReturnType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getId

public int getId()

Gets the id.

Specified by:

getId in interface IdentifiedEnum

Returns:

id

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<FunctionReturnType>