NameValuePairs - Global

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read
  • The NameValuePairs script include provides methods to convert between maps and strings representing the name/value pairs in the map.

    The string form is: <name> = <value>, <name> = <value, ... where <name> is a string name, optionally surrounded by double quotes (Microsoft-style), and <value> is a string value, also optionally surrounded by double quotes.

    The following are all examples of valid name/value strings:
    • name = value
    • name = "My Value", name = value
    • "My Name = this" = "My Value", "My Value, all the time", name = value
    • "My Name" = "This" "name""", name = value
    In the third example, the quoted values contain equals and commas. In the fourth example, the quoted value contains a quote.
    Instances have the following properties initialized:
    • map: The map (JavaScript object being used as a hashmap) form of the name/value pairs, with Microsoft-style quotes removed
    • string: The string form of the name/value pairs, with Microsoft-style quoting.

    Use with any server-side script where you need convert name/value pairs between maps and strings.

    NameValuePairs - NameValuePairs(String stringForm)

    Creates an instance of the class initialized with the specified string.

    Table 1. Parameters
    Name Type Description
    stringForm String The values to use when creating the object.

    NameValuePairs - NameValuePairs(Object mapForm)

    Creates an instance of the class initialized with the specified hash map.

    Table 2. Parameters
    Name Type Description
    mapForm Object The map to use when creating the object.

    NameValuePairs - mapToString()

    Produces this.string from this.map.

    Table 3. Parameters
    Name Type Description
    None
    Table 4. Returns
    Type Description
    void

    NameValuePairs - quotify(Object value)

    If the specified value contains double quotes, equals, commas, or spaces, this method surrounds the value with double quotes and doubles up any enclosed double quotes.

    Table 5. Parameters
    Name Type Description
    value Object The value to process
    Table 6. Returns
    Type Description
    String The value with added quotes.

    NameValuePairs - stringToMap()

    Produces this.map from this.string.

    Table 7. Parameters
    Name Type Description
    None
    Table 8. Returns
    Type Description
    void