Loading...
Searching...
No Matches
com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder > Class Template Referenceabstract

Abstract builder of AbstractRunParameters. More...

Public Member Functions

 newBuilder ()
 Creates a newBuilder instance.
 
build ()
 Abstract method to create and return an instance of AbstractRunParameters or one its subclasses.
 
setGAMSOptions (GAMSOptions option)
 Sets an instance of GAMSOptions as a run parameter.
 
setGAMSCheckpoint (GAMSCheckpoint checkpoint)
 Sets an instance of GAMSCheckpoint as a run parameter.
 
setOutput (PrintStream output)
 Sets an output Stream to capture GAMS log as a run parameter.
 
setCreateOutDB (boolean createOutDB)
 Sets a flag that determines if an output database should be created after running a job.
 
setDatabases (ArrayList< GAMSDatabase > db)
 Sets a lsit of GAMSDatabase as a run parameter.
 

Protected Member Functions

abstract T createObject ()
 Abstract method to create and return the instance of AbstractRunParameters subclass.
 
abstract B thisBuilder ()
 Abstract method to get the instance of AbstractRunParameters subclass.
 

Detailed Description

Abstract builder of AbstractRunParameters.

The builder can be used to configure parameters for running a job such as options, checkpoint, output log, flag to determine whether output database should be created and a list of input databases.

Parameters
<B>an instance of AbstractRunParameters.newBuilder subclass subclass
<T>an instance of AbstractRunParameters subclass

Constructor & Destructor Documentation

◆ newBuilder()

com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.newBuilder ( )

Creates a newBuilder instance.

Member Function Documentation

◆ build()

T com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.build ( )

Abstract method to create and return an instance of AbstractRunParameters or one its subclasses.

Returns
a new instance of AbstractRunParameters or one of its subclasses.

◆ createObject()

abstract T com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.createObject ( )
abstractprotected

Abstract method to create and return the instance of AbstractRunParameters subclass.

Returns
the instance of AbstractRunParameters subclass

◆ setCreateOutDB()

B com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.setCreateOutDB ( boolean  createOutDB)

Sets a flag that determines if an output database should be created after running a job.

Returns
the instance of AbstractRunParameters.newBuilder or one of its subclasses.

◆ setDatabases()

B com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.setDatabases ( ArrayList< GAMSDatabase db)

Sets a lsit of GAMSDatabase as a run parameter.

Returns
the instance of AbstractRunParameters.newBuilder or one of its subclasses.

◆ setGAMSCheckpoint()

B com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.setGAMSCheckpoint ( GAMSCheckpoint  checkpoint)

Sets an instance of GAMSCheckpoint as a run parameter.

Returns
the instance of AbstractRunParameters.newBuilder or one of its subclasses.

◆ setGAMSOptions()

B com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.setGAMSOptions ( GAMSOptions  option)

Sets an instance of GAMSOptions as a run parameter.

Returns
the instance of AbstractRunParameters.newBuilder or one of its subclasses.

◆ setOutput()

B com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.setOutput ( PrintStream  output)

Sets an output Stream to capture GAMS log as a run parameter.

Returns
the instance of AbstractRunParameters.newBuilder or one of its subclasses.

◆ thisBuilder()

abstract B com.gams.api.AbstractRunParameters.newBuilder< T extends AbstractRunParameters, B extends AbstractRunParameters.newBuilder >.thisBuilder ( )
abstractprotected

Abstract method to get the instance of AbstractRunParameters subclass.

Returns
the instance of AbstractRunParameters.newBuilder or one of its subclasses.