Module org.postgresql.pljava

Package org.postgresql.pljava.annotation

Enum Class Function.Effects

java.lang.Object

java.lang.Enum<Function.Effects>

org.postgresql.pljava.annotation.Function.Effects

All Implemented Interfaces:

Serializable, Comparable<Function.Effects>, Constable

Enclosing class:

Function

public static enum Function.Effects
extends Enum<Function.Effects>

The volatility category describing the presence or absence of side-effects constraining what the optimizer can safely do with the function.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IMMUTABLE
STABLE
VOLATILE

Method Summary

Modifier and Type	Method	Description
static Function.Effects	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Function.Effects[]	values()	Returns an array containing the constants of this enum class, 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 Details

IMMUTABLE

public static final Function.Effects IMMUTABLE

STABLE

public static final Function.Effects STABLE

VOLATILE

public static final Function.Effects VOLATILE

Method Details

values

public static Function.Effects[] values()

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

Returns:

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

valueOf

public static Function.Effects valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null