Class StringArgument

All Implemented Interfaces:
Serializable, Parameter

public final class StringArgument extends TypedArgument
Argument implementation for String values
See Also:
  • Constructor Details

  • Method Details

    • writeTo

      public void writeTo(OutputStream outputStream) throws IOException
      Description copied from class: Argument
      Writes the arguments to the supplied OutputStream in the XDR format of the type.
      Specified by:
      writeTo in class Argument
      Parameters:
      outputStream - OutputStream
      Throws:
      IOException - For errors writing to the OutputStream
    • getLength

      public int getLength()
      Specified by:
      getLength in 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).
    • getValueAsString

      public String 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 interface Parameter
      Overrides:
      getValueAsString in class Argument
      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 interface Parameter
      Overrides:
      getValueAsInt in class Argument
      Returns:
      The value as int
    • copyTo

      public void copyTo(ParameterBuffer buffer, Encoding stringEncoding)
      Description copied from interface: Parameter
      Copies this argument into the supplied buffer, uses the supplied Encoding for string arguments.

      An instance of Parameter should know how to copy itself into another buffer (eg an instance of StringArgument would know to call ParameterBuffer.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 they are free to try that).

      Parameters:
      buffer - ParameterBuffer instance
      stringEncoding - Encoding to use for string properties. A value of null can be used to signal that the original encoding should be used.
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object