module JavaStringBuilder: sig .. end
Utility functions for string builders.
Instance creation
val make_of_capacity : java_int -> t
Capacity and length
val capacity : t -> java_int
val ensure_capacity : t -> java_int -> unit
Ensures that the passed builder is at least equal to the passed
value; see
ensureCapacity(...).
val length : t -> java_int
Returns the length of the passed builder; see
length(...).
val set_length : t -> java_int -> unit
Sets the length of the passed builder to the passed value; see
setLength(...).
Raises Java_exception if the length is negative
val trim_to_size : t -> unit
Minimizes the amount of memory used by the passed builder; see
trimToSize(...).
Value addition
val append_boolean : t -> java_boolean -> t
Appends the passed boolean to the passed builder; see
append(...).
val append_char : t -> java_char -> t
Appends the passed character to the passed builder; see
append(...).
val append_double : t -> java_double -> t
Appends the passed double to the passed builder; see
append(...).
val append_float : t -> java_float -> t
Appends the passed float to the passed builder; see
append(...).
val append_int : t -> java_int -> t
Appends the passed integer to the passed builder; see
append(...).
val append_long : t -> java_long -> t
Appends the passed long to the passed builder; see
append(...).
val append_code_point : t -> java_int -> t
Value insertion
val insert_boolean : t -> java_int -> java_boolean -> t
Inserts the passed boolean into the passed builder at the specified
index; see
insert(...).
Raises Java_exception if the index is invalid
val insert_char : t -> java_int -> java_char -> t
Inserts the passed character into the passed builder at the specified
index; see
insert(...).
Raises Java_exception if the index is invalid
val insert_double : t -> java_int -> java_double -> t
Inserts the passed double into the passed builder at the specified
index; see
insert(...).
Raises Java_exception if the index is invalid
val insert_float : t -> java_int -> java_float -> t
Inserts the passed float into the passed builder at the specified
index; see
insert(...).
Raises Java_exception if the index is invalid
val insert_int : t -> java_int -> java_int -> t
Inserts the passed integer into the passed builder at the specified
index; see
insert(...).
Raises Java_exception if the index is invalid
val insert_long : t -> java_int -> java_long -> t
Inserts the passed long into the passed builder at the specified
index; see
insert(...).
Raises Java_exception if the index is invalid
val insert_string : t -> java_int -> JavaString.t -> t
Inserts the passed string into the passed builder at the specified
index; see
insert(...).
Raises Java_exception if the index is invalid
Character lookup and modification
val char_at : t -> java_int -> java_char
Returns the character at the passed index in the passed builder; see
charAt(...).
Raises Java_exception if the index is invalid
val set_char_at : t -> java_int -> java_char -> unit
Changes the character at the passed index in the passed builder; see
setCharAt(...).
Raises Java_exception if the index is invalid
val code_point_at : t -> java_int -> java_int
Returns the code point at the passed index in the passed builder; see
codePointAt(...).
Raises Java_exception if the index is invalid
Deletion
val delete : t -> java_int -> java_int -> t
delete sb start end deletes the characters from index
start
(inclusive) to index
end (exclusive) from builder
sb; see
delete(...).
Raises Java_exception if the indexes are invalid
val delete_char_at : t -> java_int -> t
delete_char_at sb idx deletes the characters at index
idx from
builder
sb; see
deleteCharAt(...).
Raises Java_exception if the index is invalid
Replacement
val replace : t ->
java_int -> java_int -> JavaString.t -> t
replace sb start end str replaces the characters from index
start
(inclusive) to index
end (exclusive) from builder
sb by
characters from
str; see
replace(...).
Raises Java_exception if the indexes are invalid
Search
val index_of : t -> JavaString.t -> java_int
Returns the index within the passed builder of the first occurrence
of the passed string; see
indexOf(...).
val index_of_from : t -> JavaString.t -> java_int -> java_int
Returns the index within the passed builder of the first occurrence
of the passed string, starting at the passed index; see
indexOf(...).
val last_index_of : t -> JavaString.t -> java_int
Returns the index within the passed builder of the last occurrence
of the passed string; see
lastIndexOf(...).
val last_index_of_from : t -> JavaString.t -> java_int -> java_int
Returns the index within the passed builder of the last occurrence
of the passed string, starting at the passed index; see
indexOf(...).
Conversion
val substring : t -> java_int -> java_int -> JavaString.t
substring sb start end returns a string containing the characters
of
sb from index
start (inclusive) to index
end (exclusive);
see
substring(...).
Raises Java_exception if the indexes are invalid
Null value
val null : t
The null value.
val is_null : t -> bool
is_null obj returns true iff obj is equal to null.
val is_not_null : t -> bool
is_not_null obj returns false iff obj is equal to null.
Miscellaneous
val wrap : t -> t option
wrap obj wraps the reference
obj into an option type:
Some x if obj is not null;None if obj is null.
val unwrap : t option -> t
unwrap obj unwraps the option
obj into a bare reference:
Some x is mapped to x;None is mapped to null.