Class StringArgument
- java.lang.Object
- 
- org.firebirdsql.gds.impl.argument.Argument
- 
- org.firebirdsql.gds.impl.argument.TypedArgument
- 
- org.firebirdsql.gds.impl.argument.StringArgument
 
 
 
- 
- All Implemented Interfaces:
- java.io.Serializable,- Parameter
 
 public final class StringArgument extends TypedArgument Argumentimplementation for String values- See Also:
- Serialized Form
 
- 
- 
Constructor SummaryConstructors Constructor Description StringArgument(int type, ArgumentType argumentType, java.lang.String value)Deprecated.will be removed in Jaybird 6, useStringArgument(int, ArgumentType, String, Encoding)StringArgument(int type, ArgumentType argumentType, java.lang.String value, Encoding encoding)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcopyTo(ParameterBuffer buffer, Encoding stringEncoding)Copies this argument into the supplied buffer, uses the suppliedEncodingfor string arguments.booleanequals(java.lang.Object other)intgetLength()intgetValueAsInt()The value of the parameter as int.java.lang.StringgetValueAsString()The value of the parameter as String.inthashCode()voidwriteTo(java.io.OutputStream outputStream)Writes the arguments to the suppliedOutputStreamin the XDR format of the type.- 
Methods inherited from class org.firebirdsql.gds.impl.argument.ArgumentgetType, getValueAsLong
 
- 
 
- 
- 
- 
Constructor Detail- 
StringArgument@Deprecated public StringArgument(int type, ArgumentType argumentType, java.lang.String value)Deprecated.will be removed in Jaybird 6, useStringArgument(int, ArgumentType, String, Encoding)
 - 
StringArgumentpublic StringArgument(int type, ArgumentType argumentType, java.lang.String value, Encoding encoding)
 
- 
 - 
Method Detail- 
writeTopublic void writeTo(java.io.OutputStream outputStream) throws java.io.IOExceptionDescription copied from class:ArgumentWrites the arguments to the suppliedOutputStreamin the XDR format of the type.
 - 
getLengthpublic int getLength() - Specified by:
- getLengthin class- Argument
- Returns:
- Total length of the buffer item when written to the OutputStream by Argument.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).
 
 - 
getValueAsStringpublic java.lang.String getValueAsString() Description copied from interface:ParameterThe 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:
- getValueAsStringin interface- Parameter
- Overrides:
- getValueAsStringin class- Argument
- Returns:
- The value as string
 
 - 
getValueAsIntpublic int getValueAsInt() Description copied from interface:ParameterThe 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:
- getValueAsIntin interface- Parameter
- Overrides:
- getValueAsIntin class- Argument
- Returns:
- The value as int
 
 - 
copyTopublic void copyTo(ParameterBuffer buffer, Encoding stringEncoding) Description copied from interface:ParameterCopies this argument into the supplied buffer, uses the suppliedEncodingfor string arguments.An instance of Parametershould know how to copy itself into another buffer (eg an instance ofStringArgumentwould know to callParameterBuffer.addArgument(int, String, Encoding)).The parameter does not need to check if it is the right type of destination buffer (if someone tries to add a TPB argument to a DPB he is free to try that). - Parameters:
- buffer- ParameterBuffer instance
- stringEncoding- Encoding to use for string properties. A value of- nullcan be used to signal that the original encoding should be used.
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
equalspublic boolean equals(java.lang.Object other) - Overrides:
- equalsin class- java.lang.Object
 
 
- 
 
-