Initializing help system before first use

XPRMInitializeContext

  • java.lang.Object
    • com.dashoptimization.XPRMInitializeContext

  • public abstract class XPRMInitializeContext
extends java.lang.Object
    Context used during an 'initializations from' block

    • Field Summary

      Modifier and Type Field and Description
      static int CONTROL_CLOSELST
      Code for ending a list of values in the initialization stream.
      static int CONTROL_CLOSENDX
      Code for ending a list of indices in the initialization stream.
      static int CONTROL_FLUSH
      Code to force a flush of the token queue.
      static int CONTROL_OPENLST
      Code for starting a list of values in the initialization stream.
      static int CONTROL_OPENNDX
      Code for starting a list of indices in the initialization stream.
      static int CONTROL_SKIP
      Code for skipping a position in the initialization stream.

    • Method Summary

      Modifier and Type Method and Description
      void send(boolean b)
      Send a Boolean value to the initialization stream.
      void send(boolean b, boolean flush)
      Send a Boolean value to the initialization stream.
      void send(double r)
      Send a real value to the initialization stream.
      abstract void send(double r, boolean flush)
      Send a real value to the initialization stream.
      void send(int i)
      Send an integer value to the initialization stream.
      abstract void send(int i, boolean flush)
      Send an integer value to the initialization stream.
      void send(java.lang.String s)
      Send a text value to the initialization stream.
      abstract void send(java.lang.String s, boolean flush)
      Send a text value to the initialization stream.
      void sendControl(int c)
      Send a control character to the initialization stream.
      abstract void sendControl(int c, boolean flush)
      Send a control character to the initialization stream.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • CONTROL_FLUSH

        public static final int CONTROL_FLUSH
        Code to force a flush of the token queue. When this control character is used, no new token is sent to the initialization stream but the queue of tokens is processed.
        See Also:
        sendControl(int, boolean), Constant Field Values

      • CONTROL_SKIP

        public static final int CONTROL_SKIP
        Code for skipping a position in the initialization stream. This control character may be used in place of an expected data token in order to skip the token. This corresponds to using * in a text initialization file.
        See Also:
        sendControl(int, boolean), Constant Field Values

      • CONTROL_OPENLST

        public static final int CONTROL_OPENLST
        Code for starting a list of values in the initialization stream. This control character indicates that a list of tokens is about to be sent. This corresponds to using [ in a text initialization file.
        See Also:
        sendControl(int, boolean), Constant Field Values

      • CONTROL_CLOSELST

        public static final int CONTROL_CLOSELST
        Code for ending a list of values in the initialization stream. This control character closes a list of token previously started with the control character CONTROL_OPENLST. This corresponds to using ] in a text initialization file.
        See Also:
        sendControl(int, boolean), Constant Field Values

      • CONTROL_OPENNDX

        public static final int CONTROL_OPENNDX
        Code for starting a list of indices in the initialization stream. This control character indicates that a list of indices is about to be sent. This corresponds to using ( in a text initialization file.
        See Also:
        sendControl(int, boolean), Constant Field Values

      • CONTROL_CLOSENDX

        public static final int CONTROL_CLOSENDX
        Code for ending a list of indices in the initialization stream. This control character closes a list of inidices previously started with the control character CONTROL_OPENNDX. This corresponds to using ) in a text initialization file.
        See Also:
        sendControl(int, boolean), Constant Field Values

    • Constructor Detail

      • XPRMInitializeContext

        public XPRMInitializeContext()

    • Method Detail

      • send

        public abstract void send(int i,
                          boolean flush)
                   throws java.io.IOException
        Send an integer value to the initialization stream.
        Parameters:
        i - the integer data to be sent
        flush - if true, the queue of pending tokens is flushed otherwise, flush occurs only when the queue is full
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.

      • send

        public void send(int i)
          throws java.io.IOException
        Send an integer value to the initialization stream.
        Parameters:
        i - the integer data to be sent
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.
        See Also:
        send(i,false)

      • send

        public abstract void send(double r,
                          boolean flush)
                   throws java.io.IOException
        Send a real value to the initialization stream.
        Parameters:
        r - the double data to be sent
        flush - if true, the queue of pending tokens is flushed otherwise, flush occurs only when the queue is full
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.

      • send

        public void send(double r)
          throws java.io.IOException
        Send a real value to the initialization stream.
        Parameters:
        r - the double data to be sent
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.
        See Also:
        send(r,false)

      • send

        public abstract void send(java.lang.String s,
                          boolean flush)
                   throws java.io.IOException
        Send a text value to the initialization stream.
        Parameters:
        s - the string data to be sent
        flush - if true, the queue of pending tokens is flushed otherwise, flush occurs only when the queue is full
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.

      • send

        public void send(java.lang.String s)
          throws java.io.IOException
        Send a text value to the initialization stream.
        Parameters:
        s - the string data to be sent
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.
        See Also:
        send(s,false)

      • send

        public void send(boolean b,
                 boolean flush)
          throws java.io.IOException
        Send a Boolean value to the initialization stream.
        Parameters:
        b - the Boolean data to be sent
        flush - if true, the queue of pending tokens is flushed otherwise, flush occurs only when the queue is full
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.

      • send

        public void send(boolean b)
          throws java.io.IOException
        Send a Boolean value to the initialization stream.
        Parameters:
        b - the Boolean data to be sent
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.
        See Also:
        send(b,false)

      • sendControl

        public abstract void sendControl(int c,
                                 boolean flush)
                          throws java.io.IOException
        Send a control character to the initialization stream.
        Parameters:
        c - the control to be sent
        flush - if true, the queue of pending tokens is flushed otherwise, flush occurs only when the queue is full
        Throws:
        java.io.IOException - If the flush fails due to an unexpected token.
        See Also:
        CONTROL_SKIP, CONTROL_OPENLST, CONTROL_CLOSELST, CONTROL_OPENNDX, CONTROL_CLOSENDX
Parent Topic Class Summary