oracle.javatools.db.dictionary

Enum DictionaryQueries.Params

java.lang.Object

java.lang.Enum<DictionaryQueries.Params>

oracle.javatools.db.dictionary.DictionaryQueries.Params

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DictionaryQueries.Params>

Enclosing class:

DictionaryQueries

public static enum DictionaryQueries.Params
extends java.lang.Enum<DictionaryQueries.Params>

Enumeration of possible parameters that can be used in the list queries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_TYPES ALL_TYPES - Multiple parameters (one for each type).
IDENTIFIER The identifier for the object (only relevant for db implementations that support identifiers, and therefore IdentifierBasedIDs).
NAMEREF The object name, or name like.
SCHEMA The schema/owner.
TYPES A single parameter providing list of the types being queries.

Method Summary

Modifier and Type	Method and Description
static DictionaryQueries.Params	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DictionaryQueries.Params[]	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

SCHEMA

public static final DictionaryQueries.Params SCHEMA

The schema/owner.

NAMEREF

public static final DictionaryQueries.Params NAMEREF

The object name, or name like.

IDENTIFIER

public static final DictionaryQueries.Params IDENTIFIER

The identifier for the object (only relevant for db implementations that support identifiers, and therefore IdentifierBasedIDs).

TYPES

public static final DictionaryQueries.Params TYPES

A single parameter providing list of the types being queries. Each type is quoted and the list is comma separated.

ALL_TYPES

public static final DictionaryQueries.Params ALL_TYPES

ALL_TYPES - Multiple parameters (one for each type). Can only be used if the query's parameters (? bind variables) are built dynamically. Use this for a single type parameter.

Method Detail

values

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

Returns:

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

valueOf

public static DictionaryQueries.Params 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