Class H2Updater.H2UpdaterBuilder

java.lang.Object

com.github.hypfvieh.db.H2Updater.H2UpdaterBuilder

Enclosing class:

H2Updater

public static class H2Updater.H2UpdaterBuilder
extends Object

Builder to create H2Updater instances.

Since:

1.2.1 - 2023-11-16

Author:

hypfvieh

Method Summary

Modifier and Type	Method	Description
H2Updater.H2UpdaterBuilder	addExportOption(H2Updater.ExportOption _opt)	Configure various options used for exporting the original database.
H2Updater.H2UpdaterBuilder	addImportOption(H2Updater.ImportOption _opt)	Configure various options used for importing the original database to the new database.
H2Updater.H2UpdaterBuilder	addRemoveExportOption(H2Updater.ExportOption _opt)	Remove a previously set H2Updater.ExportOption.
H2Updater.H2UpdaterBuilder	addRemoveImportOption(H2Updater.ImportOption _opt)	Remove a previously set H2Updater.ImportOption.
H2Updater	build()	Creates a new H2Updater ensuring all required properties are set.
static H2Updater.H2UpdaterBuilder	create(File _inputH2Jar, File _outputH2Jar)	Create a new builder instance to configure H2Updater.
H2Updater.H2UpdaterBuilder	withH2OpenOptions(Map<String,String> _options)	Setup additional options used when building the connection URL for reading input database.
H2Updater.H2UpdaterBuilder	withImportExportCharset(Charset _charset)	Setup the charset to use for export and importing the database.
H2Updater.H2UpdaterBuilder	withInputFile(File _h2InputFile)	Setup H2 database to convert.
H2Updater.H2UpdaterBuilder	withOutputFileName(String _outputFileName)	Setup the output database file name. This must be different to the input file name and the file must not exist. The file extension (usually .mv.db) should be omitted (will be appended by H2 automatically).

Methods inherited from class Object

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

Method Details

withH2OpenOptions

public H2Updater.H2UpdaterBuilder withH2OpenOptions(Map<String,String> _options)

Setup additional options used when building the connection URL for reading input database.

If null is given, currently configured opening options are removed.

Parameters:

_options - options to add

Returns:

this

withInputFile

public H2Updater.H2UpdaterBuilder withInputFile(File _h2InputFile)
                                         throws H2Updater.H2UpdaterException

Setup H2 database to convert.

Parameters:

_h2InputFile - database file

Returns:

this

Throws:

H2Updater.H2UpdaterException

withOutputFileName

public H2Updater.H2UpdaterBuilder withOutputFileName(String _outputFileName)
                                              throws H2Updater.H2UpdaterException

Setup the output database file name.
This must be different to the input file name and the file must not exist.
The file extension (usually .mv.db) should be omitted (will be appended by H2 automatically).

Parameters:

_outputFileName - name and path of new (converted) database

Returns:

this

Throws:

H2Updater.H2UpdaterException - when outputFileName is invalid

withImportExportCharset

public H2Updater.H2UpdaterBuilder withImportExportCharset(Charset _charset)

Setup the charset to use for export and importing the database.

Parameters:

_charset - charset to use, null to use default

Returns:

this

addExportOption

public H2Updater.H2UpdaterBuilder addExportOption(H2Updater.ExportOption _opt)
                                           throws H2Updater.H2UpdaterException

Configure various options used for exporting the original database.

Parameters:

_opt - option

Returns:

this

Throws:

H2Updater.H2UpdaterException - when invalid combinations are used

addRemoveExportOption

public H2Updater.H2UpdaterBuilder addRemoveExportOption(H2Updater.ExportOption _opt)

Remove a previously set H2Updater.ExportOption.

Parameters:

_opt - option to remove

Returns:

this

addImportOption

public H2Updater.H2UpdaterBuilder addImportOption(H2Updater.ImportOption _opt)
                                           throws H2Updater.H2UpdaterException

Configure various options used for importing the original database to the new database.

Parameters:

_opt - option

Returns:

this

Throws:

H2Updater.H2UpdaterException - when invalid combinations are used

addRemoveImportOption

public H2Updater.H2UpdaterBuilder addRemoveImportOption(H2Updater.ImportOption _opt)

Remove a previously set H2Updater.ImportOption.

Parameters:

_opt - option to remove

Returns:

this

build

public H2Updater build()
                throws H2Updater.H2UpdaterException

Creates a new H2Updater ensuring all required properties are set.

Returns:

H2Updater

Throws:

H2Updater.H2UpdaterException - when configuration is invalid or incomplete

create

public static H2Updater.H2UpdaterBuilder create(File _inputH2Jar,
 File _outputH2Jar)
                                         throws H2Updater.H2UpdaterException

Create a new builder instance to configure H2Updater.

Parameters:

_inputH2Jar - jar file of H2 to read database to convert

_outputH2Jar - jar file of H2 to write converted database with

Returns:

this

Throws:

H2Updater.H2UpdaterException - when loading jars failed