Package com.senzing.sdk.core

Class SzCoreEnvironment.Builder

java.lang.Object

com.senzing.sdk.core.SzCoreEnvironment.Builder

Enclosing class:

SzCoreEnvironment

public static class SzCoreEnvironment.Builder
extends Object

The builder class for creating an instance of SzCoreEnvironment.

Constructor Summary

Constructors

Constructor	Description
Builder()	Private constructor.

Method Summary

Modifier and Type	Method	Description
SzCoreEnvironment	build()	This method creates a new SzCoreEnvironment instance based on this SzCoreEnvironment.Builder instance.
SzCoreEnvironment.Builder	configId(Long configId)	Sets the explicit configuration ID to use to initialize the SzCoreEnvironment.
SzCoreEnvironment.Builder	instanceName(String instanceName)	Provides the Senzing instance name to configure the SzCoreEnvironment.
SzCoreEnvironment.Builder	settings(String settings)	Provides the Senzing settings to configure the SzCoreEnvironment.
SzCoreEnvironment.Builder	verboseLogging(boolean verboseLogging)	Sets the verbose logging flag for configuring the SzCoreEnvironment.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Private constructor.

Method Details

settings

public SzCoreEnvironment.Builder settings(String settings)

Provides the Senzing settings to configure the SzCoreEnvironment. If this is set to null or empty-string then SzCoreEnvironment.DEFAULT_SETTINGS will be used to provide limited funtionality.

Parameters:

settings - The Senzing settings, or null or empty-string to restore the default value.

Returns:

A reference to this instance.

See Also:

• SzCoreEnvironment.DEFAULT_SETTINGS

instanceName

public SzCoreEnvironment.Builder instanceName(String instanceName)

Provides the Senzing instance name to configure the SzCoreEnvironment. Call this method to override the default value of SzCoreEnvironment.DEFAULT_INSTANCE_NAME.

Parameters:

instanceName - The instance name to initialize the SzCoreEnvironment, or null or empty-string to restore the default.

Returns:

A reference to this instance.

See Also:

• SzCoreEnvironment.DEFAULT_INSTANCE_NAME

verboseLogging

public SzCoreEnvironment.Builder verboseLogging(boolean verboseLogging)

Sets the verbose logging flag for configuring the SzCoreEnvironment. Call this method to explicitly set the value. If not called, the default value is false.

Parameters:

verboseLogging - true if verbose logging should be enabled, otherwise false.

Returns:

A reference to this instance.

configId

public SzCoreEnvironment.Builder configId(Long configId)

Sets the explicit configuration ID to use to initialize the SzCoreEnvironment. If not specified then the default configuration ID obtained from the Senzing repository is used.

Parameters:

configId - The explicit configuration ID to use to initialize the SzCoreEnvironment, or null if the default configuration ID from the Senzing repository should be used.

Returns:

A reference to this instance.

build

public SzCoreEnvironment build()
                        throws IllegalStateException

This method creates a new SzCoreEnvironment instance based on this SzCoreEnvironment.Builder instance. This method will throw an IllegalStateException if another active SzCoreEnvironment instance exists since only one active instance can exist within a process at any given time. An active instance is one that has been constructed, but has not yet been destroyed.

Returns:

The newly created SzCoreEnvironment instance.

Throws:

IllegalStateException - If another active SzCoreEnvironment instance exists when this method is invoked.