Package com.senzing.sdk.core

Class SzCoreEnvironment.AbstractBuilder<E extends SzCoreEnvironment,B extends SzCoreEnvironment.AbstractBuilder<E,B>>

java.lang.Object

com.senzing.sdk.core.SzCoreEnvironment.AbstractBuilder<E,B>

Type Parameters:

E - The SzCoreEnvironment-derived class built by instances of this class.

B - The SzCoreEnvironment.AbstractBuilder-derived class of the implementation.

All Implemented Interfaces:

SzCoreEnvironment.Initializer

Direct Known Subclasses:

SzCoreEnvironment.Builder

Enclosing class:

SzCoreEnvironment

public abstract static class SzCoreEnvironment.AbstractBuilder<E extends SzCoreEnvironment,B extends SzCoreEnvironment.AbstractBuilder<E,B>>
extends Object
implements SzCoreEnvironment.Initializer

Provides a base class for builder implementations of SzCoreEnvironment and its derived classes.

This class is not used in the usage of SzCoreEnvironment. It is only needed if you are extending SzCoreEnvironment.

This class allows the derived builder to return references to its own environment class and to its own builder type rather than base classes. When extending SzCoreEnvironment you should provide an implementation of this class that is specific to your derived class.

Since:

4.1.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
abstract E	build()	Implement this method to create a new SzCoreEnvironment instance of type E based on this builder instance.
B	configId(Long configId)	Sets the explicit configuration ID to use to initialize the SzCoreEnvironment.
Long	getConfigId()	Gets the explicit configuration ID (if any) with which to initialize the SzCoreEnvironment.
String	getInstanceName()	Gets the Senzing instance name with which to initialize the SzCoreEnvironment.
String	getSettings()	Gets the Senzing settings with which to initialize the SzCoreEnvironment.
B	instanceName(String instanceName)	Provides the Senzing instance name to initialize the SzCoreEnvironment.
boolean	isVerboseLogging()	Checks if configuring the SzCoreEnvironment with verbose logging.
B	settings(String settings)	Provides the Senzing settings to initialize the SzCoreEnvironment.
B	verboseLogging(boolean verboseLogging)	Sets the verbose logging flag for initializing the SzCoreEnvironment.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Default constructor.

Since:

4.1.0

Method Details

settings

public B settings(String settings)

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

Parameters:

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

Returns:

A reference to this instance.

Since:

4.1.0 (4.0.0 as part of SzCoreEnvironment.Builder)

See Also:

• SzCoreEnvironment.DEFAULT_SETTINGS

getSettings

public String getSettings()

Gets the Senzing settings with which to initialize the SzCoreEnvironment.

Specified by:

getSettings in interface SzCoreEnvironment.Initializer

Returns:

The Senzing settings with which to configure the SzCoreEnvironment.

Since:

4.1.0

instanceName

public B instanceName(String instanceName)

Provides the Senzing instance name to initialize 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.

Since:

4.1.0 (4.0.0 as part of SzCoreEnvironment.Builder)

See Also:

• SzCoreEnvironment.DEFAULT_INSTANCE_NAME

getInstanceName

public String getInstanceName()

Gets the Senzing instance name with which to initialize the SzCoreEnvironment.

Specified by:

getInstanceName in interface SzCoreEnvironment.Initializer

Returns:

The Senzing instance name with which to initialize the SzCoreEnvironment.

Since:

4.1.0

verboseLogging

public B verboseLogging(boolean verboseLogging)

Sets the verbose logging flag for initializing 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.

Since:

4.1.0 (4.0.0 as part of SzCoreEnvironment.Builder)

isVerboseLogging

public boolean isVerboseLogging()

Checks if configuring the SzCoreEnvironment with verbose logging.

Specified by:

isVerboseLogging in interface SzCoreEnvironment.Initializer

Returns:

true if verbose logging will be enabled, otherwise false.

Since:

4.1.0

configId

public B 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.

Since:

4.1.0 (4.0.0 as part of SzCoreEnvironment.Builder)

getConfigId

public Long getConfigId()

Gets the explicit configuration ID (if any) with which to initialize the SzCoreEnvironment. This returns null if no explicit configuration ID has been provided and the default configuration ID from the Senzing repository should be used.

Specified by:

getConfigId in interface SzCoreEnvironment.Initializer

Returns:

The explicit configuration ID with which to initialize the SzCoreEnvironment, or null if none and the default configuration ID from the Senzing repository should be used.

Since:

4.1.0

build

public abstract E build()
                 throws IllegalStateException

Implement this method to create a new SzCoreEnvironment instance of type E based on this 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 of type E.

Throws:

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

Since:

4.1.0