Module cl.netswitch.iso
Package cl.netswitch.iso.vip8583

Class VipEncoder<M extends VipMessage>

java.lang.Object
cl.netswitch.iso.vip8583.VipEncoder<M>
Type Parameters:
M - the type of the VIP message.
public abstract class VipEncoder<M extends VipMessage> extends Object
Encodes the fields of a VipMessage into a sequence of bytes.

  • Constructor Details

    • VipEncoder

      public VipEncoder(VipFields<M> fields)
      Constructs a new VipEncoder instance.
      Parameters:
      fields - the fields that describe a message.
      Throws:
      NullPointerException - if fields is null.
      VipException - if required fields are not defined.

  • Method Details

    • encode

      public final byte[] encode(M message)
      Encodes the fields of a message into a sequence of bytes.
      Parameters:
      message - the message that contains the field values.
      Returns:
      the sequence of bytes with the encoded field values.
      Throws:
      NullPointerException - if message is null.
      VipException - if an expected encoder error occurs.

    • preEncode

      protected void preEncode(M message, ByteArray barray)
      Called before a message is encoded into the supplied byte array.
      Parameters:
      message - the message to be encoded into barray.
      barray - the byte array containing the encoded bytes.
      Throws:
      NullPointerException - if an argument is null.
      IsoException - if an expected encoder error occurs.

    • postEncode

      protected void postEncode(M message, ByteArray barray)
      Called after a message is encoded into the supplied byte array.
      Parameters:
      message - the message to be encoded into barray.
      barray - the byte array containing the encoded bytes.
      Throws:
      NullPointerException - if an argument is null.
      IsoException - if an expected encoder error occurs.