Package org.netxms.base

Class NXCPMessageField

java.lang.Object
org.netxms.base.NXCPMessageField
public class NXCPMessageField extends Object
NXCP message field (variable)

  • Field Details

  • Constructor Details

    • NXCPMessageField

      public NXCPMessageField(long fieldId, int fieldType, Long value)
      Create numeric or string field (actual type determined by fieldType parameter)
      Parameters:
      fieldId - field ID
      fieldType - field type
      value - value to set

    • NXCPMessageField

      public NXCPMessageField(long fieldId, String value, boolean forceUcsEncoding)
      Create string field
      Parameters:
      fieldId - field ID
      value - string value
      forceUcsEncoding - if true, encode field as UCS-2 instead of UTF-8

    • NXCPMessageField

      public NXCPMessageField(long fieldId, String value)
      Create string field
      Parameters:
      fieldId - field ID
      value - string value

    • NXCPMessageField

      public NXCPMessageField(long fieldId, Double value)
      Create floating point number field
      Parameters:
      fieldId - field ID
      value - floating point number value

    • NXCPMessageField

      public NXCPMessageField(long fieldId, byte[] value)
      Create binary field from given byte array
      Parameters:
      fieldId - field ID
      value - binary value

    • NXCPMessageField

      public NXCPMessageField(long fieldId, long[] value)
      Create binary field from array of long integers. Each element will be converted to network byte order and then array will be serialized as array of bytes.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(long fieldId, int[] value)
      Create binary field from array of integers. Each element will be converted to network byte order and then array will be serialized as array of bytes.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(long fieldId, Long[] value)
      Create binary field from array of long integers. Each element will be converted to network byte order and then array will be serialized as array of bytes.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(long fieldId, Integer[] value)
      Create binary field from array of integers. Each element will be converted to network byte order and then array will be serialized as array of bytes.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(long fieldId, Collection<T> value)
      Create binary field from collection of integers. Each element will be converted to 32 bit integer in network byte order and then array will be serialized as array of bytes.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(long fieldId, InetAddress value)
      Create field of InetAddress type.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(long fieldId, InetAddressEx value)
      Create field of InetAddress type.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(long fieldId, UUID value)
      Create binary field from UUID object.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(long fieldId, String[] value)
      Create binary field from array of strings integers.
      Parameters:
      fieldId - field ID
      value - value to be encoded

    • NXCPMessageField

      public NXCPMessageField(byte[] nxcpDataField) throws IOException
      Create field object from NXCP message data field
      Parameters:
      nxcpDataField - NXCP message data field
      Throws:
      IOException - if read from underlying data input stream fails

  • Method Details

    • getAsInteger

      public Long getAsInteger()
      Get field's value as long integer
      Returns:
      Field's value as long integer

    • getAsReal

      public Double getAsReal()
      Get field's value as floating point number
      Returns:
      Field's value as floating point number

    • getAsString

      public String getAsString()
      Get field's value as string
      Returns:
      Field's value as string

    • getAsBinary

      public byte[] getAsBinary()
      Get field's value as byte array
      Returns:
      Field's value as byte array

    • getAsInetAddress

      public InetAddress getAsInetAddress()
      Get field's value as IP address
      Returns:
      Field's value as IP address

    • getAsInetAddressEx

      public InetAddressEx getAsInetAddressEx()
      Get field's value as IP address/mask pair
      Returns:
      Field's value as IP address/mask pair

    • getAsUUID

      public UUID getAsUUID()
      Get field's value as UUID
      Returns:
      Field's value as UUID

    • getAsUInt32Array

      public long[] getAsUInt32Array()
      Get field's value as array of long integers. Variable should be of binary type, and integer values should be packet as DWORD's in network byte order.
      Returns:
      Field's value as array of long integers

    • getAsUInt32ArrayEx

      public Long[] getAsUInt32ArrayEx()
      Get field's value as array of long integers. Variable should be of binary type, and integer values should be packet as DWORD's in network byte order.
      Returns:
      Field's value as array of long integers

    • getAsInt32Array

      public int[] getAsInt32Array()
      Get field's value as array of integers. Variable should be of binary type, and integer values should be packet as int32_t in network byte order.
      Returns:
      Field's value as array of long integers

    • getAsInt32ArrayEx

      public Integer[] getAsInt32ArrayEx()
      Get field's value as array of integers. Variable should be of binary type, and integer values should be packet as int32_t in network byte order.
      Returns:
      Field's value as array of long integers

    • getAsStringArrayEx

      public String[] getAsStringArrayEx()
      Get field's value as array of strings.
      Returns:
      Field's value as array of strings

    • getId

      public long getId()
      Get this field ID
      Returns:
      this field ID

    • setId

      public void setId(long id)
      Set new ID for this field.
      Parameters:
      id - new ID for this field

    • getType

      public int getType()
      Get type of this field.
      Returns:
      this field type

    • createNXCPDataField

      public byte[] createNXCPDataField() throws IOException
      Create NXCP DF structure
      Returns:
      encoded NXCP data field as byte array
      Throws:
      IOException - if write to underlying data output stream fails

    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: