Package org.firebirdsql.gds.ng
Class FbBatchConfig.Immutable
- java.lang.Object
- 
- org.firebirdsql.gds.ng.FbBatchConfig.Immutable
 
- 
- All Implemented Interfaces:
- FbBatchConfig
 - Enclosing interface:
- FbBatchConfig
 
 public static final class FbBatchConfig.Immutable extends java.lang.Object implements FbBatchConfig Class to provide an immutable copy of a batch config.
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface org.firebirdsql.gds.ng.FbBatchConfigFbBatchConfig.Immutable
 
- 
 - 
Field Summary- 
Fields inherited from interface org.firebirdsql.gds.ng.FbBatchConfigCONTINUE_ON_ERROR, HALT_AT_FIRST_ERROR, NO_UPDATE_COUNTS, SERVER_DEFAULT_BUFFER_SIZE, SERVER_DEFAULT_DETAILED_ERRORS, SERVER_MAXIMUM_BUFFER_SIZE, UPDATE_COUNTS
 
- 
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description intbatchBufferSize()Server-side batch buffer size in bytes.intdetailedErrors()Number of detailed errors to return.FbBatchConfigimmutable()booleanmultiError()Multi-error behaviour.booleanupdateCounts()Report update counts per element (called "record counts" in Firebird).- 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface org.firebirdsql.gds.ng.FbBatchConfigpopulateBatchParameterBuffer
 
- 
 
- 
- 
- 
Method Detail- 
multiErrorpublic boolean multiError() Description copied from interface:FbBatchConfigMulti-error behaviour.- Specified by:
- multiErrorin interface- FbBatchConfig
- Returns:
- truerequest multi-error (continue on failure), or- falseto halt execution on first error
 
 - 
updateCountspublic boolean updateCounts() Description copied from interface:FbBatchConfigReport update counts per element (called "record counts" in Firebird).- Specified by:
- updateCountsin interface- FbBatchConfig
- Returns:
- truereport update counts,- falsedo not report update counts
 
 - 
detailedErrorspublic int detailedErrors() Description copied from interface:FbBatchConfigNumber of detailed errors to return.A value of 0disables detailed errors. When a value< 0is returned, the server-side default is used (64 as of Firebird 4). Requesting detailed errors exceeding the maximum (256 as of Firebird 4) will be silently set to the server maximum.- Specified by:
- detailedErrorsin interface- FbBatchConfig
- Returns:
- number of detailed errors, 0to disable detailed errors,< 0for server default
 
 - 
batchBufferSizepublic int batchBufferSize() Description copied from interface:FbBatchConfigServer-side batch buffer size in bytes.When a value < 0is returned, the server-side default (16MB as of Firebird 4) will be used. When a value of0is returned , the server-side maximum will be used. Requesting buffer sizes exceeding the maximum (256MB as of Firebird 4) will be silently set to the server maximum.- Specified by:
- batchBufferSizein interface- FbBatchConfig
- Returns:
- maximum batch buffer size, return < 0to use server-side default (16MB as of Firebird 4),0for the server-side maximum (256MB as of Firebird 4)
 
 - 
immutablepublic FbBatchConfig immutable() - Specified by:
- immutablein interface- FbBatchConfig
- Returns:
- immutable, frozen copy of this batch config
 
 
- 
 
-