|
@@ -21,7 +21,7 @@
|
|
|
*/
|
|
|
/**
|
|
|
This class provides advanced methods on Strings. It is ideally used with
|
|
|
- 'using StringTools' and then acts as an extension to the String class.
|
|
|
+ `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.
|
|
@@ -103,7 +103,7 @@ class StringTools {
|
|
|
Unescapes HTML special characters of the string `s`.
|
|
|
|
|
|
This is the inverse operation to htmlEscape, i.e. the following always
|
|
|
- holds: htmlUnescape(htmlEscape(s)) == s
|
|
|
+ holds: `htmlUnescape(htmlEscape(s)) == s`
|
|
|
|
|
|
The replacements follow:
|
|
|
|
|
@@ -120,9 +120,9 @@ class StringTools {
|
|
|
/**
|
|
|
Tells if the string `s` starts with the string `start`.
|
|
|
|
|
|
- If `start` is null, the result is unspecified.
|
|
|
+ If `start` is `null`, the result is unspecified.
|
|
|
|
|
|
- If `start` is the empty String "", the result is true.
|
|
|
+ If `start` is the empty String `""`, the result is true.
|
|
|
**/
|
|
|
public static #if (cs || java) inline #end function startsWith( s : String, start : String ) : Bool {
|
|
|
#if java
|
|
@@ -146,9 +146,9 @@ class StringTools {
|
|
|
/**
|
|
|
Tells if the string `s` ends with the string `end`.
|
|
|
|
|
|
- If `end` is null, the result is unspecified.
|
|
|
+ If `end` is `null`, the result is unspecified.
|
|
|
|
|
|
- If `end` is the empty String "", the result is true.
|
|
|
+ If `end` is the empty String `""`, the result is true.
|
|
|
**/
|
|
|
public static #if (cs || java) inline #end function endsWith( s : String, end : String ) : Bool {
|
|
|
#if java
|
|
@@ -177,7 +177,7 @@ class StringTools {
|
|
|
A character is considered to be a space character if its character code
|
|
|
is 9,10,11,12,13 or 32.
|
|
|
|
|
|
- If `s` is the empty String "", or if pos is not a valid position within
|
|
|
+ If `s` is the empty String `""`, or if pos is not a valid position within
|
|
|
`s`, the result is false.
|
|
|
**/
|
|
|
public static function isSpace( s : String, pos : Int ) : Bool {
|
|
@@ -191,11 +191,11 @@ class StringTools {
|
|
|
/**
|
|
|
Removes leading space characters of `s`.
|
|
|
|
|
|
- This function internally calls isSpace() to decide which characters to
|
|
|
+ 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 "".
|
|
|
+ If `s` is the empty String `""` or consists only of space characters, the
|
|
|
+ result is the empty String `""`.
|
|
|
**/
|
|
|
public #if cs inline #end static function ltrim( s : String ) : String {
|
|
|
#if cs
|
|
@@ -216,11 +216,11 @@ class StringTools {
|
|
|
/**
|
|
|
Removes trailing space characters of `s`.
|
|
|
|
|
|
- This function internally calls isSpace() to decide which characters to
|
|
|
+ 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 "".
|
|
|
+ If `s` is the empty String `""` or consists only of space characters, the
|
|
|
+ result is the empty String `""`.
|
|
|
**/
|
|
|
public #if cs inline #end static function rtrim( s : String ) : String {
|
|
|
#if cs
|
|
@@ -242,7 +242,7 @@ class StringTools {
|
|
|
/**
|
|
|
Removes leading and trailing space characters of `s`.
|
|
|
|
|
|
- This is a convenience function for ltrim(rtrim(s)).
|
|
|
+ This is a convenience function for `ltrim(rtrim(s))`.
|
|
|
**/
|
|
|
public #if (cs || java) inline #end static function trim( s : String ) : String {
|
|
|
#if cs
|
|
@@ -257,7 +257,7 @@ class StringTools {
|
|
|
/**
|
|
|
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`,
|
|
|
+ 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`.
|
|
@@ -279,7 +279,7 @@ class StringTools {
|
|
|
/**
|
|
|
Appends `c` to `s` until `s.length` is at least `l`.
|
|
|
|
|
|
- If `c` is the empty String "" or if `l` does not exceed `s.length`,
|
|
|
+ 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`.
|
|
@@ -302,8 +302,8 @@ class StringTools {
|
|
|
Replace all occurences 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`. If `by` is also the empty String "", `s` remains unchanged.
|
|
|
+ If `sub` is the empty String `""`, `by` is inserted after each character
|
|
|
+ of `s`. If `by` is also the empty String `""`, `s` remains unchanged.
|
|
|
|
|
|
This is a convenience function for `s.split(sub).join(by)`.
|
|
|
|
|
@@ -329,7 +329,7 @@ class StringTools {
|
|
|
Encodes `n` into a hexadecimal representation.
|
|
|
|
|
|
If `digits` is specified, the resulting String is padded with "0" until
|
|
|
- its length equals `digits`.
|
|
|
+ its `length` equals `digits`.
|
|
|
**/
|
|
|
public static function hex( n : Int, ?digits : Int ) {
|
|
|
#if flash
|
|
@@ -363,14 +363,14 @@ class StringTools {
|
|
|
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
|
|
|
+ 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
|
|
|
+ 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
|
|
|
+ This operation is not guaranteed to work if `s` contains the `\0`
|
|
|
character.
|
|
|
**/
|
|
|
public static inline function fastCodeAt( s : String, index : Int ) : Int {
|