StringTools

StringTools (Class)

This class provides advanced methods on Strings. It is ideally used with using StringTools and then acts as an extension to the String class.

If the first argument to any of the methods is null, the result is unspecified.

Static Members

urlEncode(s: String): String

Encode an URL by using the standard format.

Name Type
s String
Returns
String
urlDecode(s: String): String

Decode an URL using the standard format.

Name Type
s String
Returns
String
htmlEscape(s: String, ?quotes: Bool): String

Escapes HTML special characters of the string s.

The following replacements are made:

  • & becomes &
  • < becomes &lt;
  • > becomes &gt;

If quotes is true, the following characters are also replaced:

  • " becomes &quot;
  • ' becomes &#039;
Name Type Default
s String
quotes Bool (optional)
Returns
String
startsWith(s: String, start: String): Bool

Tells if the string s starts with the string start.

If start is null, the result is unspecified.

If start is the empty String "", the result is true.

Name Type
s String
start String
Returns
Bool
endsWith(s: String, end: String): Bool

Tells if the string s ends with the string end.

If end is null, the result is unspecified.

If end is the empty String "", the result is true.

Name Type
s String
end String
Returns
Bool
ltrim(s: String): String

Removes leading space characters of s.

This function internally calls isSpace() to decide which characters to remove.

If s is the empty String "" or consists only of space characters, the result is the empty String "".

Name Type
s String
Returns
String
trim(s: String): String

Removes leading and trailing space characters of s.

This is a convenience function for ltrim(rtrim(s)).

Name Type
s String
Returns
String
lpad(s: String, c: String, l: Int): String

Concatenates c to s until s.length is at least l.

If c is the empty String "" or if l does not exceed s.length, s is returned unchanged.

If c.length is 1, the resulting String length is exactly l.

Otherwise the length may exceed l.

If c is null, the result is unspecified.

Name Type
s String
c String
l Int
Returns
String
replace(s: String, sub: String, by: String): String

Replace all occurrences of the String sub in the String s by the String by.

If sub is the empty String "", by is inserted after each character of s except the last one. If by is also the empty String "", s remains unchanged.

If sub or by are null, the result is unspecified.

Name Type
s String
sub String
by String
Returns
String
hex(n: Int, ?digits: Int): String

Encodes n into a hexadecimal representation.

If digits is specified, the resulting String is padded with "0" until its length equals digits.

Name Type Default
n Int
digits Int (optional)
Returns
String
fastCodeAt(s: String, index: Int): Int

Returns the character code at position index of String s, or an end-of-file indicator at if position equals s.length.

This method is faster than String.charCodeAt() on some platforms, but the result is unspecified if index is negative or greater than s.length.

End of file status can be checked by calling StringTools.isEof() with the returned value as argument.

This operation is not guaranteed to work if s contains the \0 character.

Name Type
s String
index Int
Returns
Int
unsafeCodeAt(s: String, index: Int): Int

Returns the character code at position index of String s, or an end-of-file indicator at if position equals s.length.

This method is faster than String.charCodeAt() on some platforms, but the result is unspecified if index is negative or greater than s.length.

This operation is not guaranteed to work if s contains the \0 character.

Name Type
s String
index Int
Returns
Int
isEof(c: Int): Bool

Tells if c represents the end-of-file (EOF) character.

Name Type
c Int
Returns
Bool

Private Members

utf16CodePointAt(s: String, index: Int): Int
Name Type
s String
index Int
Returns
Int

Metadata

Name Parameters
:hxGen -