schemacrawler.schemacrawler

Class LimitOptionsBuilder

java.lang.Object

schemacrawler.schemacrawler.LimitOptionsBuilder

All Implemented Interfaces:

OptionsBuilder<LimitOptionsBuilder,LimitOptions>

public final class LimitOptionsBuilder
extends Object
implements OptionsBuilder<LimitOptionsBuilder,LimitOptions>

SchemaCrawler options builder, to build the immutable options to crawl a schema.

Method Summary

Modifier and Type	Method and Description
static LimitOptionsBuilder	builder()
LimitOptionsBuilder	fromOptions(LimitOptions options)
LimitOptionsBuilder	include(DatabaseObjectRuleForInclusion ruleForInclusion, InclusionRule inclusionRule)
LimitOptionsBuilder	includeAllRoutines()
LimitOptionsBuilder	includeAllSequences()
LimitOptionsBuilder	includeAllSynonyms()
LimitOptionsBuilder	includeColumns(InclusionRule columnInclusionRule)
LimitOptionsBuilder	includeColumns(Pattern columnPattern)
LimitOptionsBuilder	includeRoutineParameters(InclusionRule routineParameterInclusionRule)
LimitOptionsBuilder	includeRoutineParameters(Pattern routineParameterPattern)
LimitOptionsBuilder	includeRoutines(InclusionRule routineInclusionRule)
LimitOptionsBuilder	includeRoutines(Pattern routinePattern)
LimitOptionsBuilder	includeSchemas(InclusionRule schemaInclusionRule)
LimitOptionsBuilder	includeSchemas(Pattern schemaPattern)
LimitOptionsBuilder	includeSequences(InclusionRule sequenceInclusionRule)
LimitOptionsBuilder	includeSequences(Pattern sequencePattern)
LimitOptionsBuilder	includeSynonyms(InclusionRule synonymInclusionRule)
LimitOptionsBuilder	includeSynonyms(Pattern synonymPattern)
LimitOptionsBuilder	includeTables(InclusionRule tableInclusionRule)
LimitOptionsBuilder	includeTables(Pattern tablePattern)
static LimitOptions	newLimitOptions()
LimitOptionsBuilder	routineTypes(Collection<RoutineType> routineTypes) Sets routine types from a collection of routine types.
LimitOptionsBuilder	routineTypes(String routineTypesString) Sets routine types from a comma-separated list of routine types.
LimitOptionsBuilder	tableNamePattern(String tableNamePattern)
LimitOptionsBuilder	tableTypes(Collection<String> tableTypeStrings) Sets table types from a collection of table types.
LimitOptionsBuilder	tableTypes(String... tableTypeStrings) Sets table types from an array of table types.
LimitOptionsBuilder	tableTypes(String tableTypesString) Sets table types requested for output from a comma-separated list of table types.
LimitOptions	toOptions()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static LimitOptionsBuilder builder()

newLimitOptions

public static LimitOptions newLimitOptions()

fromOptions

public LimitOptionsBuilder fromOptions(LimitOptions options)

Specified by:

fromOptions in interface OptionsBuilder<LimitOptionsBuilder,LimitOptions>

include

public LimitOptionsBuilder include(DatabaseObjectRuleForInclusion ruleForInclusion,
                                   InclusionRule inclusionRule)

includeAllRoutines

public LimitOptionsBuilder includeAllRoutines()

includeAllSequences

public LimitOptionsBuilder includeAllSequences()

includeAllSynonyms

public LimitOptionsBuilder includeAllSynonyms()

includeColumns

public LimitOptionsBuilder includeColumns(InclusionRule columnInclusionRule)

includeColumns

public LimitOptionsBuilder includeColumns(Pattern columnPattern)

includeRoutineParameters

public LimitOptionsBuilder includeRoutineParameters(InclusionRule routineParameterInclusionRule)

includeRoutineParameters

public LimitOptionsBuilder includeRoutineParameters(Pattern routineParameterPattern)

includeRoutines

public LimitOptionsBuilder includeRoutines(InclusionRule routineInclusionRule)

includeRoutines

public LimitOptionsBuilder includeRoutines(Pattern routinePattern)

includeSchemas

public LimitOptionsBuilder includeSchemas(InclusionRule schemaInclusionRule)

includeSchemas

public LimitOptionsBuilder includeSchemas(Pattern schemaPattern)

includeSequences

public LimitOptionsBuilder includeSequences(InclusionRule sequenceInclusionRule)

includeSequences

public LimitOptionsBuilder includeSequences(Pattern sequencePattern)

includeSynonyms

public LimitOptionsBuilder includeSynonyms(InclusionRule synonymInclusionRule)

includeSynonyms

public LimitOptionsBuilder includeSynonyms(Pattern synonymPattern)

includeTables

public LimitOptionsBuilder includeTables(InclusionRule tableInclusionRule)

includeTables

public LimitOptionsBuilder includeTables(Pattern tablePattern)

routineTypes

public LimitOptionsBuilder routineTypes(Collection<RoutineType> routineTypes)

Sets routine types from a collection of routine types.

Parameters:

routineTypes - Collection of routine types. Can be null if all supported routine types are requested.

routineTypes

public LimitOptionsBuilder routineTypes(String routineTypesString)

Sets routine types from a comma-separated list of routine types. A null string resets to the defaults, which includes all procedures and functions.

Parameters:

routineTypesString - Comma-separated list of routine types. Can be null if all supported routine types are requested.

tableNamePattern

public LimitOptionsBuilder tableNamePattern(String tableNamePattern)

tableTypes

public LimitOptionsBuilder tableTypes(Collection<String> tableTypeStrings)

Sets table types from a collection of table types.

Parameters:

tableTypeStrings - Collection of table types. Can be null if all supported table types are requested.

tableTypes

public LimitOptionsBuilder tableTypes(String... tableTypeStrings)

Sets table types from an array of table types.

Parameters:

tableTypeStrings - Collection of table types. Can be null if all supported table types are requested.

tableTypes

public LimitOptionsBuilder tableTypes(String tableTypesString)

Sets table types requested for output from a comma-separated list of table types. For example: TABLE,VIEW,SYSTEM_TABLE,GLOBAL TEMPORARY,ALIAS,SYNONYM

Parameters:

tableTypesString - Comma-separated list of table types. Can be null if all supported table types are requested.

toOptions

public LimitOptions toOptions()

Specified by:

toOptions in interface OptionsBuilder<LimitOptionsBuilder,LimitOptions>