ParameterBufferMetaData (Jaybird API)

All Known Implementing Classes:

DatabaseParameterBufferImp.DpbMetaData, ServiceParameterBufferImp.SpbMetaData, ServiceRequestBufferImp.SrbMetaData, TransactionParameterBufferImpl.TpbMetaData
```
public interface ParameterBufferMetaData
```
Additional metadata for parameter buffer behavior.

Since:

3.0

Author:

Mark Rotteveel

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPreamble(ParameterBuffer parameterBuffer)` Allows the metadata to add a preamble to the parameter buffer.
`ArgumentType`	`getByteArrayArgumentType(int tag)` Gets the byte array argument type for the supplied tag.
`ArgumentType`	`getIntegerArgumentType(int tag)` Gets the byte array argument type for the supplied tag.
`ArgumentType`	`getStringArgumentType(int tag)` Gets the string argument type for the supplied tag.
`int`	`getType()` Parameter buffer type (this usually is the version of the parameter buffer).

- Method Detail
  - getType
```
int getType()
```
    Parameter buffer type (this usually is the version of the parameter buffer).
    
    Returns:
    
    Buffer type (for example ISCConstants.isc_spb_version3).
  - addPreamble
```
void addPreamble(ParameterBuffer parameterBuffer)
```
    Allows the metadata to add a preamble to the parameter buffer.
    This is only intended for the weird "version 2" connection service parameter buffer that requires two tags for the version with isc_spb_version, isc_spb_current_version.
    
    Parameters:
    
    parameterBuffer - Parameter buffer.
  - getStringArgumentType
```
ArgumentType getStringArgumentType(int tag)
```
    Gets the string argument type for the supplied tag.
    When the tag is not known (or unsupported for string arguments), then the default should be returned.
    
    Parameters:
    
    tag - Tag (item type)
    
    Returns:
    
    Argument type (never null)
  - getByteArrayArgumentType
```
ArgumentType getByteArrayArgumentType(int tag)
```
    Gets the byte array argument type for the supplied tag.
    When the tag is not known (or unsupported for string arguments), then the default should be returned.
    
    Parameters:
    
    tag - Tag (item type)
    
    Returns:
    
    Argument type (never null)
  - getIntegerArgumentType
```
ArgumentType getIntegerArgumentType(int tag)
```
    Gets the byte array argument type for the supplied tag.
    When the tag is not known (or unsupported for string arguments), then the default should be returned.
    
    Parameters:
    
    tag - Tag (item type)
    
    Returns:
    
    Argument type (never null)

Interface ParameterBufferMetaData

Method Summary

Method Detail

getType

addPreamble

getStringArgumentType

getByteArrayArgumentType

getIntegerArgumentType