Isom.Base.StringList

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Base.StringList

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Base.StringList

Beschreibung

Isom.Base.StringList repräsentiert Listen von Zeichenketten (Isom.Base.String).

Zu beachten:
Es gibt zwei Möglichkeiten, um auf die Elemente in der Liste zuzugreifen:
  • durch einen indizierten Zugriff mit der Funktion .At()
  • durch Durchlaufen der Liste mit den Funktionen .HasNext() und .Next(). Vor einem Durchlaufen sollte Reset() aufgerufen werden.


Funktionen

Isom.Base.StringList.AddGlobal

Speichert eine Kopie dieser Liste als globale Variable.

Isom.Base.Boolean Isom.Base.StringList.AddGlobal  ( Isom.Base.String  key,
Isom.Base.StringList  value  )

Speichert eine Kopie dieser Liste als globale Variable.

Die übergebene Zeichenkette ist der Schlüssel, mit dem die gespeicherte Variable danach mit .GetGlobal() abgerufen werden kann. Existiert bereits eine globale Variable mit dem Schlüssel, wird der vorher gesicherte Wert ersetzt.

 StringList list = StringList.CreateStringList(); 
 StringList.AddGlobal("A", list); 
Parameter:
key  Schlüssel, mit dem die Zeichenkette als globale Variable gespeichert wird.
value  Zeichenkette, die gespeichert wird.
Rückgabe:
'true', falls die Zeichenkette als globale Variable gespeichert werden konnte, 'false' sonst (z.B. bei einem ungültigen Objekt für Schlüssel oder Wert).
Isom.Base.StringList.AddStringToGlobalList

Fügt eine Zeichenkette zu einer in einer globalen Variablen gesicherten Zeichenkettenliste hinzu.

Isom.Base.Boolean Isom.Base.StringList.AddStringToGlobalList  ( Isom.Base.String  key,
Isom.Base.String  value,
Isom.Base.Boolean  insertUnique  )

Fügt eine Zeichenkette zu einer in einer globalen Variablen gesicherten Zeichenkettenliste hinzu.

Als Schlüssel dient die übergebene Zeichenkette key. Existiert unter diesem Schlüssel keine Zeichenkettenliste, so wird sie erzeugt.

Parameter:
key  Schlüssel der als globale Variable abgelegten Zeichenkettenliste, zu der die Zeichenkette hinzugefügt wird.
value  Zeichenkette, die hinzugefügt werden soll.
insertUnique  Wahrheitswert, der angibt, ob die Zeichenkette auch eingefügt werden soll, wenn sie bereits in der globalen Zeichenkettenliste enthalten ist. Ist Wert 'true', so wird die Zeichenkette nicht der Liste hinzugefügt, falls sie bereits enthalten ist.
Rückgabe:
'true', falls die Zeichenkette zu der globalen Zeichenkettenliste hinzugefügt werden konnte, 'false' sonst (z.B. weil der Schlüssel oder der Wert das Void-Objekt waren).
Isom.Base.StringList.At

Ruft eine durch einen Index gekennzeichnete Zeichenkette aus der Liste ab.

objectbound Isom.Base.String Isom.Base.StringList.At  ( Isom.Base.Number  index  ) 

Ruft eine durch einen Index gekennzeichnete Zeichenkette aus der Liste ab.

 StringList list = StringList.CreateStringList(); 
 list.Insert("A"); 
 String a = list.At(0);               //a ist "A" 
 String b = list.At(1);               //b ist das Void-Objekt 
Parameter:
index  Index des abgerufenen Elements in der Liste, beginnend bei 0 für das erste Element.
Rückgabe:
Zeichenkette mit dem übergebenen Index.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Index kleiner als 0 ist oder größer gleich der Anzahl der Listenelemente.
Isom.Base.StringList.Clone

Erzeugt eine identische Kopie dieses Objekts.

objectbound Isom.Base.StringList Isom.Base.StringList.Clone  (  ) 

Erzeugt eine identische Kopie dieses Objekts.

Dabei werden für alle enthaltenen Zeichenkettenobjekte ebenso Kopien erzeugt.

Rückgabe:
Kopie dieses Objekts.
Isom.Base.StringList.Concat

Liefert eine Zeichenkette, die alle Elemente der Liste enthält.

objectbound Isom.Base.String Isom.Base.StringList.Concat  ( Isom.Base.String  separator  ) 

Liefert eine Zeichenkette, die alle Elemente der Liste enthält.

Zwischen den einzelnen Elementen wird die Separator- zeichenkette eingefügt. Diese Separatorzeichenkette kann auch die leere Zeichenkette "" sein. In diesem Falle, werden nur alle Zeichenketten dieser Liste aneinandergehängt.

 StringList list = StringList.CreateStringList(); 
 list.Insert("A"); 
 list.Insert("B"); 
 list.Insert("C"); 
 list.Insert("D"); 
 String s = list.Concat(",");   // s ist "A,B,C,D" 
Parameter:
separator  Separatorzeichenkette, die zwischen den einzelnen Elementen der Liste eingefügt wird.
Rückgabe:
Aus den Elementen konstruierte Zeichenkette.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die Separatorzeichenkette das Void-Objekt ist.
Isom.Base.StringList.Contains

Abfrage, ob ein Element in der Liste vorhanden ist.

objectbound Isom.Base.Boolean Isom.Base.StringList.Contains  ( Isom.Base.String  element  ) 

Abfrage, ob ein Element in der Liste vorhanden ist.

 StringList list = StringList.CreateStringList(); 
 list.Insert("A"); 
 Boolean contains = list.Contains("B");   // contains ist false 
 Boolean contains = list.Contains("A");   // contains ist true 
Parameter:
element  Gesuchtes Element.
Rückgabe:
'true', falls das Element gefunden werden konnte, 'false' sonst.
Siehe auch:
Isom.Base.StringList.ContainsIgnoreCase() für Variante ohne Berücksichtigung der Groß-/Kleinschreibung.
Isom.Base.StringList.ContainsIgnoreCase

Abfrage, ob ein Element unter Vernachlässigung der Groß-/Kleinschreibung (case) in der Liste vorhanden ist.

objectbound Isom.Base.Boolean Isom.Base.StringList.ContainsIgnoreCase  ( Isom.Base.String  element  ) 

Abfrage, ob ein Element unter Vernachlässigung der Groß-/Kleinschreibung (case) in der Liste vorhanden ist.

 StringList list = StringList.CreateStringList(); 
 list.Insert("A"); 
 Boolean contains = list.ContainsIgnoreCase("b");   // contains ist false 
 Boolean contains = list.ContainsIgnoreCase("a");   // contains ist true 
Parameter:
element  Gesuchtes Element.
Rückgabe:
'true', falls das Element gefunden werden konnte, 'false' sonst.
Siehe auch:
Isom.Base.StringList.Contains() für Variante mit Berücksichtigung der Groß-/Kleinschreibung.
Isom.Base.StringList.CreateStringList

Erzeugt eine neue, leere Zeichenkettenliste.

Isom.Base.StringList Isom.Base.StringList.CreateStringList  (  ) 

Erzeugt eine neue, leere Zeichenkettenliste.

 StringList list = StringList.CreateStringList(); 
Rückgabe:
Leere Liste.
Isom.Base.StringList.Current

Liefert während des Durchlaufens der Liste die aktuelle Zeichenkette.

objectbound Isom.Base.String Isom.Base.StringList.Current  (  ) 

Liefert während des Durchlaufens der Liste die aktuelle Zeichenkette.

 StringList list = ... 
 list.Reset();                        //Listendurchlauf vorbereiten 
 while (list.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    list.Next();                      //Durchlauf weiterführen 
    Number current = list.Current();  //Element abrufen 
    ... 
 } 
Rückgabe:
Aktuelles Element der Liste.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Durchlauf-Iterator vor das erste Element der Liste zeigt.
Isom.Base.StringList.GetExistingGlobals

Ruft eine Liste der Schlüssel aller globalen Variablen des Typs 'StringList' ab

Isom.Base.StringList Isom.Base.StringList.GetExistingGlobals  (  ) 

Ruft eine Liste der Schlüssel aller globalen Variablen des Typs 'StringList' ab

   StringList list1 = StringList.CreateStringList(); 
   list1.Insert("A1"); 
   list1.Insert("A2"); 
   StringList.AddGlobal("A", list1); 

   StringList list2 = StringList.CreateStringList(); 
   list2.Insert("B1"); 
   String.AddGlobal("B", list2); 

   StringList keys = StringList.GetExistingGlobals(); // enthält "A" und "B" 
Rückgabe:
Liste der Schlüssel aller globalen Variablen des Typs 'StringList'
Isom.Base.StringList.GetGlobal

Ruft die Liste ab, welche als globale Variable unter dem Schlüssel für Zeichenkettenlisten gespeichert wurde.

Isom.Base.StringList Isom.Base.StringList.GetGlobal  ( Isom.Base.String  key  ) 

Ruft die Liste ab, welche als globale Variable unter dem Schlüssel für Zeichenkettenlisten gespeichert wurde.

Parameter:
key  Schlüssel, unter dem die Liste im globalen Variablenfeld gesucht wird.
Rückgabe:
Kopie des im globalen Variablenfeld gespeicherten Wertes. Änderungen an diesem Rückgabewert ändern nicht den im globalen Variablenfeld gespeicherten Wert.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls innerhalb dieser Sitzung noch keine Variable unter diesem Schlüssel abgespeichert wurde oder der Schlüssel das Void-Objekt ist.
Isom.Base.StringList.HasNext

Prüft, ob es beim Durchlaufen der Liste mit .Next() Zeichenketten gibt, die noch nicht abgerufen wurden.

objectbound Isom.Base.Boolean Isom.Base.StringList.HasNext  (  ) 

Prüft, ob es beim Durchlaufen der Liste mit .Next() Zeichenketten gibt, die noch nicht abgerufen wurden.

 StringList list = ... 
 list.Reset();                        //Listendurchlauf vorbereiten 
 while (list.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    Number current = list.Next();     //Element abrufen und Durchlauf weiterführen 
    ... 
 } 
Rückgabe:
'true', falls noch Zeichenketten in der Liste mit .Next() abgerufen werden können, 'false' sonst.
Isom.Base.StringList.Insert

Fügt der Liste ein Element hinzu.

objectbound Isom.Base.Number Isom.Base.StringList.Insert  ( Isom.Base.String  element  ) 

Fügt der Liste ein Element hinzu.

Das Element wird an der letzten Position der Liste eingefügt. Ein eventuell aktiver Durchlauf-Iterator wird durch diese Operation zurückgesetzt.

 StringList list = StringList.CreateStringList(); 
 list.Insert("A"); 
Zu beachten:
Der zurückgegebene Index des eingefügten Elements ist nur gültig, solange kein Element an einer Position mit einem kleineren Index aus der Liste entfernt wird.
Parameter:
element  Hinzuzufügendes Zeichenkette.
Rückgabe:
Isom.Base.Number
Aktueller Index des eingefügten Elements in der Liste.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls das Element nicht hinzugefügt werden konnte.
Isom.Base.StringList.IsEmpty

Prüft, ob diese Liste leer ist oder nicht.

objectbound Isom.Base.Boolean Isom.Base.StringList.IsEmpty  (  ) 

Prüft, ob diese Liste leer ist oder nicht.

 StringList list = StringList.CreateStringList(); 
 Boolean isEmpty = list.IsEmpty();    // isEmpty ist true 
 list.Insert("A"); 
 isEmpty = list.IsEmpty();            // isEmpty ist false 
Rückgabe:
'true', falls die Liste leer ist, 'false' sonst.
Isom.Base.StringList.IsVoid

Bestimmt, ob es sich um das Void-Objekt handelt.

objectbound Isom.Base.Boolean Isom.Base.StringList.IsVoid  (  ) 

Bestimmt, ob es sich um das Void-Objekt handelt.

Rückgabe:
'true', falls dies das Void-Objekt ist, 'false' sonst.
Isom.Base.StringList.Length

Liefert die Anzahl der Elemente in der Liste.

objectbound Isom.Base.Number Isom.Base.StringList.Length  (  ) 

Liefert die Anzahl der Elemente in der Liste.

 StringList list = StringList.CreateStringList(); 
 list.Insert("A"); 
 list.Insert("B"); 
 list.Insert("C"); 
 list.Insert("D"); 
 Number length = list.Length();       //length ist 4 
Rückgabe:
Anzahl der Elemente.
Isom.Base.StringList.Next

Liefert beim Durchlaufen der Liste die nächste Zeichenkette.

objectbound Isom.Base.String Isom.Base.StringList.Next  (  ) 

Liefert beim Durchlaufen der Liste die nächste Zeichenkette.

Ein Listendurchlauf wird mit .Reset() zurückgesetzt, um sie mit .Next() vom Listenanfang an durchlaufen zu können.

 StringList list = ... 
 list.Reset();                        //Listendurchlauf vorbereiten 
 while (list.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    Number current = list.Next();     //Element abrufen und Durchlauf weiterführen 
    ... 
 } 
Rückgabe:
Nächstes Element der Liste.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls keine weiteren Elemente in der Liste sind.
Isom.Base.StringList.Remove

Entfernt ein durch einen Index gekennzeichnetes Element aus der Liste.

objectbound Isom.Base.Boolean Isom.Base.StringList.Remove  ( Isom.Base.Number  index  ) 

Entfernt ein durch einen Index gekennzeichnetes Element aus der Liste.

Ein eventuell aktiver Durchlauf-Iterator, wird durch diese Operation zurückgesetzt.

Parameter:
index  Index des zu entfernenden Elements in der Liste, beginnend bei 0 für das erste Element.
 StringList list = StringList.CreateStringList(); 
 Boolean result = list.Remove(0);       //result ist false 
 list.Insert("A"); 
 result = list.Remove(0);               //result ist true 
Rückgabe:
'true', falls das Element entfernt werden konnte, 'false' sonst (z.B. wenn der Index das Void-Objekt ist oder außerhalb des zulässigen Bereichs liegt).
Isom.Base.StringList.RemoveAll

Entfernt alle Vorkommen der vorgegebenen Zeichenkette in der Liste.

objectbound Isom.Base.Boolean Isom.Base.StringList.RemoveAll  ( Isom.Base.String  value  ) 

Entfernt alle Vorkommen der vorgegebenen Zeichenkette in der Liste.

 StringList list = StringList.CreateStringList(); 
 list.Insert("A"); 
 list.Insert("A"); 
 list.Insert("A"); 
 result = list.RemoveAll("B");            // result ist false 
 Boolean isEmpty = list.isEmpty();          // isEmpty ist false 
 result = list.RemoveAll("A");            // result ist true 
 Boolean isEmpty = list.isEmpty();          // isEmpty ist true 
Parameter:
value  Zu entfernender String-Wert.
Rückgabe:
'true', falls mindestens ein Element entfernt werden konnte, 'false' sonst.
Isom.Base.StringList.RemoveGlobal

Entfernt eine Liste, die als globale Variable unter dem übergebenen Schlüssel gespeichert wurde.

Isom.Base.Boolean Isom.Base.StringList.RemoveGlobal  ( Isom.Base.String  key  ) 

Entfernt eine Liste, die als globale Variable unter dem übergebenen Schlüssel gespeichert wurde.

Parameter:
key  Schlüssel, unter dem die globale Variable abgelegt wurde
Rückgabe:
'true', falls die globale Variable mit dem Schlüssel gelöscht wurde 'false, falls unter dem Schlüssel keine globale Variable abgelegt war.
Isom.Base.StringList.Reset

Setzt den Durchlauf-Iterator vor das erste Element der Liste, so ein neuer Durchlauf der Liste begonnen werden kann.

objectbound Isom.Base.Boolean Isom.Base.StringList.Reset  (  ) 

Setzt den Durchlauf-Iterator vor das erste Element der Liste, so ein neuer Durchlauf der Liste begonnen werden kann.

 StringList list = ... 
 list.Reset();                        //Listendurchlauf vorbereiten 
 while (list.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    Number current = list.Next();     //Element abrufen und Durchlauf weiterführen 
    ... 
 } 
Rückgabe:
Immer 'true'.
Isom.Base.StringList.Sort

Sortiert alle Listenelementen aphabetisch aufsteigend

objectbound Isom.Base.StringList Isom.Base.StringList.Sort  (  ) 

Sortiert alle Listenelementen aphabetisch aufsteigend

Rückgabe:
alphabetische Sortierung der Listenelementen aufsteigend
Isom.Base.StringList.Void

Erzeugt ein Void-Objekt.

Isom.Base.StringList Isom.Base.StringList.Void  (  ) 

Erzeugt ein Void-Objekt.

Das erzeugte Void-Objekt kann z. B. in Funktionen zurückgegeben werden, um einen Fehler anzuzeigen.

Rückgabe:
Void-Objekt

Version 9.10.1.0 vom 25 November 2013