SPVM::StringList - Dynamic string array
Name Usage Description Super Class Interfaces Fields capacity length Class Methods new new_len new_ref Instance Methods get insert pop push remove replace splice set shift to_array unshift clone push_ unshift_ get_array Copyright & LicenseName
SPVM::StringList − Dynamic string array
Usage
use StringList;
# Create a string list
my $list = StringList−>new;
my $list = StringList−>new(["abc",
"def", "ghi"]);
# Create a string list
my $list = StringList−>new_len(10);
# Get list length
my $length = $list−>length;
# Push string value
$list−>push("abc");
# Pop string value.
my $element = $list−>pop;
# Unshift string value.
$list−>unshift("abc");
# Shift string value.
my $element = $list−>shift;
# Set string value.
$list−>set(2, "abc");
# Get string value.
my $element = $list−>get(2);
# Insert string value
$list−>insert(1, "abc");
# Remove string value
my $element = $list−>remove(1);
# Convert StringList to string array.
my $array = $list−>to_array;
Description
"StringList" is a dynamic "string" array.
Super Class
List.
Interfaces
|
• |
Cloneable |
|||
|
• |
Countable |
Fields
capacity
has capacity : ro int;
The capacity. This is the length of the internally reserved elements to extend the length of the list.
length
has length : ro int;
The length of the list.
Class Methods
new
"static method new : StringList ($array : string[] = undef, $capacity : int = −1);"
Create a new "StringList" object using "new_len".
The passed length to "new_len" is the length of the array. If the array is undef, the length is 0.
The element's addresses of the string array are copied to the values of the the created array.
Examples:
my $list =
StringList−>new;
my $list = StringList−>new(["abc",
"def", "ghi"]);
new_len
"static method new_len : StringList ($length : int, $capacity : int = −1);"
Creates a new "StringList" object with $length and $capacity.
If $capacity is less than 0, the capacity is set to the default value.
If $length is greater than $capacity, $capacity is set to $length.
Exceptions:
$length must be greater than or equal to 0. Otherwise an exception is thrown.
new_ref
"static method new_ref : StringList ($array : string[]);"
Creates a new StringList object, and set "array" field to the array $array, and return the new object.
Exceptions:
The array $array must be defined. Otherwise an exception is thrown.
Instance Methods
get
"method get : string ($index : int);"
Gets the element of the position of $index.
If $index is a netative value, $index is set to "length" plus $index.
Exceptions:
$index must be greater than or equal to 0. Otherwise an exception is thrown.
$index must be less than the length of $list. Otherwise an exception is thrown.
insert
"method insert : void ($index : int, $element : string);"
Inserts an $element to the position of $index.
Exceptions:
$index must be greater than or equal to 0. Otherwise an exception is thrown.
$index must be less than or equal to the length of $list. Otherwise an exception is thrown.
pop
"method pop : string ();"
Removes the last element and return it.
Exceptions:
The length of $list must be greater than 0. Otherwise an exception is thrown.
push
"method push : void ($element : string);"
Adds an $element after the end of the list.
remove
"method remove : string ($index : int);"
Removes the element at the position of $index and return it.
Exceptions:
$index must be greater than or equal to 0. Otherwise an exception is thrown.
$index must be less than the length of $list. Otherwise an exception is thrown.
replace
"method replace : void ($offset : int, $remove_length : int, $replace : string[] = undef);"
Same as "splice" method, but the return vlaue is not returned.
Exceptions:
Exceptions thrown by ""splice" method could be thrown.
splice
"method splice : string[] ($offset : int, $remove_length : int, $replace : string[] = undef);"
Replaces the elements of the range specified by $offset and $length with $replace array, and returns removed elements creating a new array.
If $replace is not defined, the replacemnet is not performed.
Exceptions:
$offset must be greater than or equal to 0. Otherwise an exception is thrown.
$remove_length must be greater than or equal to 0. Otherwise an exception is thrown.
$offset + $removing length must be less than or equal to the length of $list. Otherwise an exception is thrown.
set
"method set : void ($index : int, $element : string);"
Sets $element at the position of $index.
If $index is a netative value, $index is set to "length" plus $index.
Exceptions:
$index must be greater than or equal to 0. Otherwise an exception is thrown.
$index must be less than the length of $list. Otherwise an exception is thrown.
shift
"method shift : string ();"
Removes the first element and return it.
Exceptions:
The length of $list must be greater than 0. Otherwise an exception is thrown.
to_array
"method to_array : string[] ();"
Converts the list to an array.
unshift
"method unshift : void ($element : string);"
Inserts an $element at the beginning of the list.
clone
"method clone : StringList ();"
Clones this instance and returns it.
Each element is cloned by "copy" operator.
push_
"method push_ : void ($elements : string[]);"
Adds the elements $elements after the end of this list.
This method calls "push" method internally.
Exceptions:
The elements $elements must be defined.
Exceptions thrown by "push" method could be thrown.
unshift_
"method unshift_ : void ($elements : string[]);"
Inserts the elements $elements at the beginning of the list.
Exceptions:
The elements $elements must be defined.
Exceptions thrown by "unshift" method could be thrown.
get_array
"method get_array : string[] ();"
Returns the internal "array".
Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License