Package org.firebirdsql.gds.impl
Enum DatabaseParameterBufferImp.DpbMetaData
- java.lang.Object
-
- java.lang.Enum<DatabaseParameterBufferImp.DpbMetaData>
-
- org.firebirdsql.gds.impl.DatabaseParameterBufferImp.DpbMetaData
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<DatabaseParameterBufferImp.DpbMetaData>,ParameterBufferMetaData
- Enclosing class:
- DatabaseParameterBufferImp
public static enum DatabaseParameterBufferImp.DpbMetaData extends java.lang.Enum<DatabaseParameterBufferImp.DpbMetaData> implements ParameterBufferMetaData
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DPB_VERSION_1DPB_VERSION_2
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddPreamble(ParameterBuffer parameterBuffer)Allows the metadata to add a preamble to the parameter buffer.ArgumentTypegetByteArrayArgumentType(int tag)Gets the byte array argument type for the supplied tag.ArgumentTypegetIntegerArgumentType(int tag)Gets the byte array argument type for the supplied tag.ArgumentTypegetStringArgumentType(int tag)Gets the string argument type for the supplied tag.intgetType()Parameter buffer type (this usually is the version of the parameter buffer).static DatabaseParameterBufferImp.DpbMetaDatavalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static DatabaseParameterBufferImp.DpbMetaData[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
DPB_VERSION_1
public static final DatabaseParameterBufferImp.DpbMetaData DPB_VERSION_1
-
DPB_VERSION_2
public static final DatabaseParameterBufferImp.DpbMetaData DPB_VERSION_2
-
-
Method Detail
-
values
public static DatabaseParameterBufferImp.DpbMetaData[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (DatabaseParameterBufferImp.DpbMetaData c : DatabaseParameterBufferImp.DpbMetaData.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DatabaseParameterBufferImp.DpbMetaData valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
getType
public final int getType()
Description copied from interface:ParameterBufferMetaDataParameter buffer type (this usually is the version of the parameter buffer).- Specified by:
getTypein interfaceParameterBufferMetaData- Returns:
- Buffer type (for example
ISCConstants.isc_spb_version3).
-
addPreamble
public final void addPreamble(ParameterBuffer parameterBuffer)
Description copied from interface:ParameterBufferMetaDataAllows 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.- Specified by:
addPreamblein interfaceParameterBufferMetaData- Parameters:
parameterBuffer- Parameter buffer.
-
getStringArgumentType
public final ArgumentType getStringArgumentType(int tag)
Description copied from interface:ParameterBufferMetaDataGets 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.
- Specified by:
getStringArgumentTypein interfaceParameterBufferMetaData- Parameters:
tag- Tag (item type)- Returns:
- Argument type (never
null)
-
getByteArrayArgumentType
public final ArgumentType getByteArrayArgumentType(int tag)
Description copied from interface:ParameterBufferMetaDataGets 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.
- Specified by:
getByteArrayArgumentTypein interfaceParameterBufferMetaData- Parameters:
tag- Tag (item type)- Returns:
- Argument type (never
null)
-
getIntegerArgumentType
public final ArgumentType getIntegerArgumentType(int tag)
Description copied from interface:ParameterBufferMetaDataGets 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.
- Specified by:
getIntegerArgumentTypein interfaceParameterBufferMetaData- Parameters:
tag- Tag (item type)- Returns:
- Argument type (never
null)
-
-