Package step.repository.alm.otaclient

Interface ITextParser

  • All Superinterfaces:
    com4j.Com4jObject
    public interface ITextParser
extends com4j.Com4jObject
    Utilities for handling parameters in a string.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearParam​(java.lang.Object vParam)
      Clear the parameter - Set its value to null.
      int count()
      Gets the number of parameters.
      void evaluateText()
      Converts the parameters to their values.
      void initialize​(java.lang.String startClose, java.lang.String endClose, java.lang.String typeClose, int maxLen, java.lang.String defaultType)
      Initializes the parser.
      boolean paramExist​(java.lang.String paramName)
      Checks if a parameter with the specified name exists.
      java.lang.String paramName​(int nPosition)
      Gets the parameter name.
      java.lang.String paramType​(java.lang.Object vParam)
      Gets the user-defined Parameter Type.
      java.lang.String paramValue​(java.lang.Object vParam)
      The parameter value.
      void paramValue​(java.lang.Object vParam, java.lang.String pVal)
      The parameter value.
      java.lang.String text()
      The text to be parsed.
      void text​(java.lang.String pVal)
      The text to be parsed.
      int type​(java.lang.Object vParam)
      Gets the Parameter Type - predefined, null, or regular.

      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

    • Method Detail

      • count

        int count()

        Gets the number of parameters.

        Getter method for the COM property "Count"

        Returns:
        Returns a value of type int

      • paramValue

        java.lang.String paramValue​(java.lang.Object vParam)

        The parameter value.

        Getter method for the COM property "ParamValue"

        Parameters:
        vParam - Mandatory java.lang.Object parameter.
        Returns:
        Returns a value of type java.lang.String

      • paramValue

        void paramValue​(java.lang.Object vParam,
                java.lang.String pVal)

        The parameter value.

        Setter method for the COM property "ParamValue"

        Parameters:
        vParam - Mandatory java.lang.Object parameter.
        pVal - Mandatory java.lang.String parameter.

      • clearParam

        void clearParam​(java.lang.Object vParam)

        Clear the parameter - Set its value to null.

        Parameters:
        vParam - Mandatory java.lang.Object parameter.

      • type

        int type​(java.lang.Object vParam)

        Gets the Parameter Type - predefined, null, or regular.

        Getter method for the COM property "Type"

        Parameters:
        vParam - Mandatory java.lang.Object parameter.
        Returns:
        Returns a value of type int

      • paramType

        java.lang.String paramType​(java.lang.Object vParam)

        Gets the user-defined Parameter Type.

        Getter method for the COM property "ParamType"

        Parameters:
        vParam - Mandatory java.lang.Object parameter.
        Returns:
        Returns a value of type java.lang.String

      • paramExist

        boolean paramExist​(java.lang.String paramName)

        Checks if a parameter with the specified name exists.

        Getter method for the COM property "ParamExist"

        Parameters:
        paramName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type boolean

      • paramName

        java.lang.String paramName​(int nPosition)

        Gets the parameter name.

        Getter method for the COM property "ParamName"

        Parameters:
        nPosition - Mandatory int parameter.
        Returns:
        Returns a value of type java.lang.String

      • initialize

        void initialize​(@DefaultValue("<%")
                java.lang.String startClose,
                @DefaultValue("%>")
                java.lang.String endClose,
                @DefaultValue("?")
                java.lang.String typeClose,
                @DefaultValue("-1")
                int maxLen,
                @DefaultValue("string")
                java.lang.String defaultType)

        Initializes the parser.

        Parameters:
        startClose - Optional parameter. Default value is "<%"
        endClose - Optional parameter. Default value is "%>"
        typeClose - Optional parameter. Default value is "?"
        maxLen - Optional parameter. Default value is -1
        defaultType - Optional parameter. Default value is "string"

      • text

        void text​(java.lang.String pVal)

        The text to be parsed.

        Setter method for the COM property "Text"

        Parameters:
        pVal - Mandatory java.lang.String parameter.

      • text

        java.lang.String text()

        The text to be parsed.

        Getter method for the COM property "Text"

        Returns:
        Returns a value of type java.lang.String

      • evaluateText

        void evaluateText()

        Converts the parameters to their values.