java.lang.Object
org.firebirdsql.gds.impl.argument.Argument
- All Implemented Interfaces:
Serializable
,Parameter
- Direct Known Subclasses:
TypedArgument
Base class for arguments to the parameter buffer.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract int
final int
getType()
The type identifier of the parameter (usually one of the constant values inISCConstants
).int
The value of the parameter as int.long
The value of the parameter as long.The value of the parameter as String.abstract void
writeTo
(OutputStream outputStream) Writes the arguments to the suppliedOutputStream
in the XDR format of the type.
-
Constructor Details
-
Argument
protected Argument(int type)
-
-
Method Details
-
getType
public final int getType()Description copied from interface:Parameter
The type identifier of the parameter (usually one of the constant values inISCConstants
). -
getValueAsString
Description copied from interface:Parameter
The value of the parameter as String.The implementation may throw a RuntimeException if the parameter isn't a string (or shouldn't be used as a string).
- Specified by:
getValueAsString
in interfaceParameter
- Returns:
- The value as string
-
getValueAsInt
public int getValueAsInt()Description copied from interface:Parameter
The value of the parameter as int.The implementation may throw a RuntimeException if the parameter isn't an int (or shouldn't be used as an int).
- Specified by:
getValueAsInt
in interfaceParameter
- Returns:
- The value as int
-
getValueAsLong
public long getValueAsLong()Description copied from interface:Parameter
The value of the parameter as long.The implementation may throw a RuntimeException if the parameter isn't a long (or shouldn't be used as a long).
- Specified by:
getValueAsLong
in interfaceParameter
- Returns:
- The value as long
-
writeTo
Writes the arguments to the suppliedOutputStream
in the XDR format of the type.- Parameters:
outputStream
- OutputStream- Throws:
IOException
- For errors writing to the OutputStream
-
getLength
public abstract int getLength()- Returns:
- Total length of the buffer item when written to the OutputStream by
writeTo(java.io.OutputStream)
. This includes the item, the value and other items contributing to the total length (e.g. the length of the value).
-