Groovy: Anhang - Vordefinierte Methoden

← Groovy im Entwicklungsprozess | ↑ Inhalt | → Anhang - Wichtige Klassen und Interfaces

Vordefinierte Methoden (gelegentlich auch als Groovy-JDK oder GDK-Methoden bezeichnet) sind ein wichtiger Bestandteil der Groovy-Laufzeitbibliothek. Mit ihrer Hilfe werden Objekte mit zusätzlicher Funktionalität versehen, wenn sie Instanzen bestimmter Klassen oder Interfaces sind. Diese zusätzlichen Methoden dienen teilweise nur der Vereinfachung des Programmierens, teilweise sind sie aber auch erforderlich, um die speziellen Eigenschaften der Sprache Groovy richtig nutzen zu können. Als vordefinierte Methoden können sie in Groovy den vorhandenen Java-Klassen zugeordnet werden, ohne dass in irgendeiner Weise in Vererbungshierarchien eingegriffen werden muss.

Dieser Anhang soll helfen, einen Überblick über die zahlreichen vordefinierten Methoden zu erlangen, und als Nachschlagewerk dienen. Um die Übersichtlichkeit zu erhöhen, haben wir einige Vereinfachungen vorgenommen; es ist aber immer erkennbar, welche Methoden zu welchem Java-Typ anwendbar sind.

Zur Beschreibung der Methoden benutzen wir eine abgekürzte Form, die nicht der Groovy-Sprachsyntax entspricht, aber eine schnelle Orientierung erlaubt und sich an Java 5.0 anlehnt.

• Die Methoden werden generell in der Form Ergebnistyp methodenname (Parameter) dargestellt.
• Parametrisierte Typennamen im Stil von Java 5.0, wie List<String> deuten an, dass Container-Typen aus Objekten bestimmter Typen bestehen.
• Drei Punkte (...) weisen darauf hin, dass das Argument mit dem betreffenden Typ mehrfach angegeben oder auch weggelassen werden kann.
• Closure-Parameter werden in geschweiften Klammern dargestellt, dabei sind vor dem -> die Parameter und dahinter der erwartete Ergebnistyp der Closure angegeben. Beispiel:

void each { Object element -> void }

Hier ist der Parameter der Methode each() eine Closure, die als Parameter ein Objekt aus der Collection erhält und von der kein Ergebnis erwartet wird. Die Methode selbst liefert ebenfalls kein Ergebnis.

Allgemeine Hilfsmethoden

Die hier aufgeführten vordefinierten Methoden dienen dazu, an jeder beliebigen Stelle im Programm bestimmte Funktionen auszulösen. Diese Methoden sind zwar prinzipiell der Klasse Object zugeordnet, haben aber keinerlei spezifischen Bezug zu dem Objekt, an oder in dem sie aufgerufen werden. Daher werden sie wie Funktionen einer nicht objektorientierten Sprache verwendet.

addShutdownHook()

void addShutdownHook { null -> void }

Die angegebene argumentlose Closure wird als eigener Thread automatisch beim Beenden der aktuellen virtuellen Maschine ausgeführt.

print...()

void print (obj)

void println (obj)

void println ()

void printf (String format, Object ... args)

Ruft die analogen Methoden des Standardausgabe-Streams System.out auf. Die Methode printf() steht nur zur Verfügung, wenn Groovy unter Java 5.0 betrieben wird.

sleep()

static void sleep (long millis)

static void sleep (long millis) { java.lang.InterruptedExceptin ex -> void }

Diese statische Methode unterbricht die Ausführung für die angegebene Anzahl von Millisekunden. Unterbrechungen werden während dieser Zeit intern abgefangen; man kann also davon ausgehen, dass die angegebene Zeit tatsächlich ungefähr eingehalten wird. Wenn eine Closure angegeben ist, wird diese im Fall einer Unterbrechung mit einer InterruptedException als Argument aufgerufen.

sprintf()

void sprintf (String format, Object ... args)

Wie printf(), allerdings wird das Ergebnis als String zurückgegeben und nicht auf der Konsole ausgegeben.

use()

Object use (Class ... kategorien) { null -> Object }

Object use (List<Class> kategorien) { null -> Object }

Die beiden Methoden bewirken die Ausführung der übergebenen Closure, dabei werden bei allen innerhalb der Closure (auch indirekt) ausgelösten Methodenaufrufen die in den Kategorienklassen definierten Methoden wie vordefinierte Methoden behandelt. Im Gegensatz zu den vordefinierten Methoden von Groovy haben diese Methoden jedoch Vorrang vor den Methoden, die durch die jeweiligen Objekte selbst deklariert sind. Die beiden use-Methoden unterscheiden sich darin, dass bei der einen eine variable Anzahl einzelner Kategorienklassen und bei der anderen eine Liste von Kategorienklassen angegeben werden kann.

Beide Methoden liefern den Rückgabewert der Closure ihrerseits als Ergebnis zurück.

Für alle Objekte geltende Methoden

Die folgenden Methoden sind für java.lang.Object definiert und gelten damit für alle Objekte, sofern sie nicht in der betreffenden Klasse überschrieben sind und sofern es keine spezifischeren vordefinierten Methoden gibt. Aus Gründen der Übersichtlichkeit sind sie hier vorangestellt.

Für manche diese Methoden gibt es für bestimmte Typen spezialisierte Varianten; diese sind in dieser Übersicht nur dann noch einmal gesondert aufgeführt, wenn sie für den jeweiligen Typ eine spezifische Bedeutung haben.

Diese Methoden sind in einem Groovy-Programm für alle Objekte definiert. Neben den hier aufgelisteten gibt es einige weitere vordefinierte Methoden, die zwar der Klasse Object zugeordnet sind, aber keinen Bezug zu dem Objekt haben, in dem sie aufgerufen werden. Diese sind weiter oben unter ##Allgemeine Hilfsmethoden## gesondert aufgeführt.

asType()

<T> T asType(java.lang.Class<T> type)

Wandelt das aktuelle Objekt in eine Instanz des angegebenen Typs um. Dient zur Implementierung des as-Operators. Die Methode asType() kann wird aber in vielen Klassen überschrieben.

dump()

String dump()

Generiert einen Zusammenfassenden String aus Klassennamen, Hashcode und Feldern des Objekts, der besonders für Debugging-Zwecke geeignet ist.

getAt() ‒ Operator: [ ](Index)

Object getAt (String property)

Ermöglich den lesenden Zugriff auf die Properties eines Objects über den Property-Namen wie auf den Index einer Map.

Beispiel: objekt[index] wird übersetzt in objekt.getAt(index), und dies ist wiederum gleichbedeutend mit objekt.getProperty(index).

getMetaPropertyValues()

List<MetaProperty> getMetaPropertyValues()

Liefert eine Liste aus Objekten des Typs groovy.lang.MetaProperty. Diese Objekte beschreiben die Properties des aktuellen Objekts.

getProperties()

Map<String,Object> getProperties()

Liefert eine Map mit Name-Wert-Paaren, die alle Properties des Objekts enthält. Die Map kann nicht zum Setzen von Properties im Objekt verwendet werden.

identity()

identity { Object thisObject -> Object } : Object

Ruft die Closure mit dem aktuellen Objekt selbst als Argumente auf. Objektreferenzen in der Closure werden ebenfalls über das aktuelle Objekt aufgelöst, da es gleichzeitig als Delegate angemeldet ist. Die Zeile

objekt.identity { closure }

ist also ungefähr gleichbedeutend mit

closure.delegate=objektclosure.call (objekt)

Allerdings ist nach dem call()-Aufruf der Delegate nicht mehr gesetzt.

inspect()

String inspect ()

Generiert einen String, dessen Inhalt die Form, mit der in einem Groovy-Programm ein Objekt mit demselben Inhalt wie das aktuelle Objekt gebildet werden könnte. Wenn dies nicht möglich ist, liefert die Methode dasselbe Ergebnis wie toString().

Beispiel: Das Ergebnis von [1,2,3].inspect() ist ein String mit dem Inhalt "[1,2,3]".

invokeMethod()

Object invokeMethod (String name, Object args)

Ruft die Methode mit dem angegebenen Namen und den den in args enthaltenen Argumenten auf. Dabei kann args ein einzelnes Argument oder ein Array mit Argumenten sein.

is()

is (Object obj) : Boolean

Prüft, ob das aktuelle Objekt identisch mit dem als Argument übergebenen Objekt ist. Diese Methode wird benötigt, da der Gleichtheitsoperator (==) in Groovy die equals()-Methode aufruft und nicht, wie in Java, auf Objektidentität prüft.

isCase()

isCase (Object switchObjekt) : Boolean

Prüft, ob das als Argument übergebene switch-Objekt in einer switch-case-Verzeweigung ein „Fall“ des aktuellen Objekts ist. Wenn diese Methode nicht überladen ist, gibt sie das Ergebnis eines Aufrufs von equals(switchObject) zurück.

print...()

print (PrintWriter writer)

println (PrintWriter writer)

Gibt eine String-Repräsentation des aktuellen Objekts über die print()- bzw. println()-Methode des angegebenen PrintWriter aus.

putAt()

putAt (String name, Object wert)

Ermöglich den lesenden Zugriff auf die Properties eines Objekts über den Property-Namen wie auf den Index einer Map.

Iterative Methoden

Die Groovy-Laufzeitbibliothek definiert eine Reihe von Methoden, mit denen Objektmengen iterativ abgearbeitet werden können und die für verschiedene Containerklassen in der gleichen Form definiert sind. Sie gelten auch für einzelne Objekte, die keine Container sind; in diesem Fall wird das Objekt wie ein Container behandelt, der nur dieses eine Objekt enthält.

any()

boolean any()

boolean any { Object element -> boolean }

Prüft, ob mindestens eines der enthaltenen Elemente den Wert true ergibt. wenn eine Closure angeben ist, wird diese für die Prüfung jedes einzelnen Elements aufgerufen; andernfalls werden die Groovy-Regeln für die Interpretation von Wahrheitswerten angewendet. Verwendet die iterate()-Methode des aktuellen Objekts. Die Schleife wird abgebrochen, sobald ein Closure-Aufruf true liefert.

collect()

Collection collect (Collection collection = new List()) { Object element -> Object }

Liefert eine Collection aus den Ergebnissen, die von der angegebenen Closure bei dem Aufruf für jedes Element geliefert werden. Wenn eine Collection als Argument übergeben worden ist, werden die Closure-Ergebnisse zu dieser hinzugefügt, andernfalls legt die Methode ein neues List-Objekt an.

each()

void each { Object element -> void }

Führt die angegebene Closure für jedes Element aus.

eachWithIndex()

void eachWithIndex { Object element, int index -> void }

Führt die angegebene Closure für jedes Element aus. Der Closure wird neben dem jeweiligen Element auch ein laufender Zähler, beginnend bei 0, übergeben.

every()

boolean every { Object element -> boolean }

boolean every()

Prüft, ob alle enthaltenen Elemente den Wert true ergeben. Wenn eine Closure angeben ist, wird diese für die Prüfung jedes einzelnen Elements aufgerufen; andernfalls werden die Groovy-Regeln für die Interpretation von Wahrheitswerten angewendet. Verwendet die iterate()-Methode des aktuellen Objekts.

find()

Object find { Object element -> boolean }

Ermittelt das erste Element, für das die angegebene Closure true ergibt.

findAll()

List findAll { Object element -> boolean }

Stellt eine Liste aus allen Elementen zusammen, für die die angegebene Closure true ergibt.

findIndexOf()

int findIndexOf { Object element -> boolean }

Ermittelt den Index, beginnend bei 0, des ersten Elements, für das die angegebene Closure true ergibt.

grep()

List grep (Object filter)

Durchläuft alle Elemente des aktuellen Objekts und liefert alle Elemente daraus, die mit dem als Argument übergebenen Objekt übereinstimmen, als Liste zurück. Ob es eine Übereinstimmung gibt, wird jeweils durch einen Aufruf von obj.isCase() ermittelt.

iterator()

Iterator iterator()

Liefert einen Iterator über alle enthaltenen Elemente. Diese Methode existiert bei vielen Java-Klassen, die mit dem Collection-Framwork konform gehen. Standardmäßig liefert diese Methode einen Iterator, der nur gelesen werden kann und als einziges Element das aktuelle Objekt liefert.

Array- und Listenmethoden

Eine weitere Gruppe von vordefinierten Methoden ist auf alle Objekte anwendbar, die Elemente enthalten, auf die über einen numerischen Index zugegriffen werden kann. Standardmäßig sind dies alle Arrays sowie Objekte, die das Interface java.util.List implementieren.

Es versteht sich von selbst, dass bei typisierten Arrays ausgelesene oder zugewiesene Elemente immer vom entsprechenden Typ sein müssen, auch wenn sie im Folgenden als Object bezeichnet sind.

Neben den hier aufgeführten vordefinierten Methoden sind auf diese Objekte natürlich auch die obigen iterativen Methoden anwendbar.

equals()

boolean equals(java.lang.Object[] right)

boolean equals(java.util.List right)

Diese Varianten der standardmäßigen equals()-Methode ermöglichen es, Listen Arrays untereinander und gegenseitig zu vergleichen. Die Methoden liefern dann und nur dann true, wenn entweder beide Objekte null sind oder beide Objekte gleich viel Elemente haben und der Vergleich aller Elemente mit an der gleichen Position equals() true ergibt.

getAt() ‒ lesender Index-Operator [ ]

Object getAt (int index)

Liefert das Element mit dem angegebenen Index.

List getAt (Collection indices)

List getAt (Range indexIntervall)

Liefert eine Liste der Elemente mit den angegebenen Indices. Die gewünschten Indices können durch eine Collection oder durch ein Intervall benannt sein.

inject()

Object inject (Object arg) { Object arg, Object element -> Object }

Durchläuft die Elemente in der Weise, dass im ersten Durchgang der Closure das übergeben Argument und der erste Listenwert übergeben wird. In den folgenden Durchgängen erhält die Closure dann jeweils das Closure-Ergebnis des vorherigen Durchgangs und den entsprechenden Listenwert. Das Ergebnis des letzten Closure-Aufrufs stellt dann den Rückgabewert der Methode inject() dar.

join()

String join (String separator)

Wandelt alle Elemente in Strings um und verknüpft sie zu einem langen String, dabei wird der angegebene Separator jeweils zwischen zwei Elementen eingefügt.

putAt() ‒ schreibender Index-Operator [ ]

void putAt(int index, Object value)

Setzt den Wert mit dem angegebenen Index. Listen werden, wenn der Wert außerhalb der aktuellen Listenlänge liegt, entsprechend vergrößert und mit null-Werten aufgefüllt.

size()

int size()

Liefert die aktuelle Größe des Container-Objekts. Diese Methode ist bei Collections ohnehin vorhanden; die vordefinierte Methode für Arrays ermöglicht es, Arrays und Collections in der gleichen Weise zu behandeln.

toList()

List toList()

Wenn das aktuelle Objekt ein Array ist, bildet die Methode eine modifizierbare Liste aus dessen Elementen. Bei Arrays aus primitiven Typen findet ein entsprechendes Boxing statt. Wenn das aktuelle Objekt bereits eine Liste ist, wird es selbst zurückgegeben.

Methoden zu einzelnen Java-Typen

Primitive Typen

Zu byte[]

encodeBase64()

Writable encodeBase64()

Erzeugt ein Objekt, das das Interface groovy.lang.Writable implementiert und den in Base64 kodierten Inhalt des Arrays enthält. Dieser kann über seine Methode write() effizient in einen Writer geschrieben werden. Ein Aufruf von toString() an dem Ergebnis liefert den kodierten Wert als String.

Das Gegenstück zu dieser Methode ist die String-Methode decodeBase64().

Package java.io

Zu java.io.BufferedReader

getText()

String getText()

Liest den gesamten Inhalt des Readers in einen String und schließt den Reader anschließend.

Zu java.io.BufferedWriter

writeLine()

void writeLine (String line)

Schreibt einen String in den Writer und fügt einen plattformspezifischen Zeilenwechsel hinzu.

Zu java.io.DataInputStream

iterator()

Iterator<Byte> iterator ()

Liefert einen Iterator, der den Inhalt des Datenstroms als Bytes liefert.

Zu java.io.File

append()

void append (Object text)

void append (Object text, String zeichensatz)

Wandelt das Argument in einen String um und schreibt ihn an das Ende der Datei. Wenn der Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Standardkodierung angewandt.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine schreibbare Textdatei bezeichnet.

asWritable()

Writable asWritable ()

java.io.File asWritable (String encoding)

Wandelt die Datei in ein Objekt, das das Interface groovy.lang.Writable implementiert. Dies ermöglicht es, den Inhalt der Datei direkt über einen Writer auszugeben. Wenn der Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Standardkodierung angewandt.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine lesbare Textdatei bezeichnet.

eachByte()

void eachByte { Byte byte -> void }

Ruft die angegebene Closure für jedes Byte der Datei auf.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine lesbare Datei bezeichnet.

eachDir()

void eachDir { File dir -> void }

Ruft die angegebene Closure für jedes im Verzeichnis enthaltene Unterverzeichnis auf.

Diese Methode setzt voraus, dass das aktuelle File-Objekt ein Dateiverzeichnis bezeichnet.

eachDirMatch()

void eachDirMatch (Object filter) { File dir -> void }

Ruft die angegebene Closure für jedes im Verzeichnis enthaltene Unterverzeichnis auf, sofern der Aufruf der Methode isCase() beim Filter mit dem Unterverzeichnis true ergibt.

Diese Methode setzt voraus, dass das aktuelle File-Objekt ein Dateiverzeichnis bezeichnet.

eachDirRecurse()

void eachDirRecurse { File dir -> void }

Ruft die angegebene Closure rekursiv für jedes im Verzeichnis enthaltene Unterverzeichnis auf.

Diese Methode setzt voraus, dass das aktuelle File-Objekt ein Dateiverzeichnis bezeichnet.

eachFile()

void eachFile { File datei -> void }

Ruft die angegebene Closure für jede im Verzeichnis enthaltene Datei auf.

Diese Methode setzt voraus, dass das aktuelle File-Objekt ein Dateiverzeichnis bezeichnet.

eachFileMatch()

void eachFileMatch (Object filter) { File datei -> void }

Ruft die angegebene Closure für jede im Verzeichnis enthaltene Datei auf, sofern der Aufruf der Methode isCase() beim Filter mit dieser Datei true ergibt.

Diese Methode setzt voraus, dass das aktuelle File-Objekt ein Dateiverzeichnis bezeichnet.

eachFileRecurse()

void eachFileRecurse { File datei -> void }

Ruft die angegebene Closure rekursiv für jede im Verzeichnis enthaltene Datei auf.

Diese Methode setzt voraus, dass das aktuelle File-Objekt ein Dateiverzeichnis bezeichnet.

eachLine()

void eachLine { String zeile -> void }

Liest die Datei zeilenweise und ruft mit jeder Zeile die angegebene Closure auf. Die Kodierung wird aus dem Inhalt der Datei ermittelt.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine lesbare Textdatei bezeichnet.

eachObject()

void eachObject { Object obj -> void }

Liest die Datei Objekt für Objekt und ruft jeweils die angegebene Closure auf.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine Datei mit serialisierten Objekten bezeichnet.

filterLine()

Writable filterLine { String zeile -> boolean }

Erzeugt ein Objekt, das Interface groovy.lang.Writable implementiert und alle Zeilen enthält, für die die angegebene Closure true ergibt.

void filterLine (Writer writer) { String zeile -> boolean }

Schreibt alle Zeilen der Datei in den angegebenen Writer, bei denen der Aufruf der Closure true ergibt.

Beide Methoden setzen voraus, dass das aktuelle File-Objekt eine lesbare Textdatei bezeichnet.

getText()

String getText ()

String getText (String zeichensatz)

Liest den gesamten Inhalt der Datei in einen String. Wenn der Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Kodierung aus dem Inhalt ermittelt.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine lesbare Textdatei bezeichnet.

iterator()

Iterator<String> iterator()

Liefert einen Iterator, mit dem die Datei zeilenweise gelesen werden kann.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine lesbare Textdatei bezeichnet.

leftShift() ‒ Operator <<

File leftShift (Object text)

Wandelt das Argument in einen String um und schreibt ihn an das Ende der Datei. Wenn der Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Standardkodierung angewandt.

Als Ergebnis wird das aktuelle File-Objekt geliefert, so dass diese Operation auch verkettet werden kann.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine schreibbare Textdatei bezeichnet.

new Stream(), new Writer(), new Reader()

DataInputStream newDataInputStream ()

DataOutputStream newDataOutputStream ()

BufferedInputStream newInputStream ()

ObjectInputStream newObjectInputStream ()

ObjectOutputStream newObjectOutputStream ()

BufferedOutputStream newOutputStream ()

PrintWriter newPrintWriter (String zeichensatz=null)

BufferedReader newReader ()

BufferedReader newReader (String zeichensatz=null)

BufferedWriter newWriter (java.lang.String zeichensatz=null, boolean append=false)

Einfache Hilfsmethoden zum Erzeugen eine Streams, eines Readers oder eines Writers für das aktuelle File-Objekt. Wenn der Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Kodierung aus dem Inhalt ermittelt. Wenn der Parameter append auf true gesetzt ist, wird ein Writer erzeugt, der an den bestehenden Inhalt der Datei anfügt; andernfalls werden bei schreibenden Streams und Writern gegebenenfalls die Dateien überschrieben.

Diese Methoden setzen voraus, dass das aktuelle File-Objekt eine les- bzw. schreibbare Textdatei bezeichnet.

readBytes()

byte[] readBytes()

Liest den gesamten Inhalt der Datei in ein byte-Array.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine lesbare Datei bezeichnet.

readLines()

List<String> readLines()

Liest den gesamten Inhalt der Datei zeilenweise in eine Liste von Strings.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine lesbare Textdatei bezeichnet.

size()

long size()

Ermittelt die Länge der Datei. Diese Methode ist ein Synonym für die length()-Methode der Klasse File, soll aber sicherstellen, dass es eine einheitliche Methode für die Abfrage der Größe eines Objekts gibt.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine Datei bezeichnet.

splitEachLine()

void splitEachLine (String regex) { String ... args -> void }

Zerteilt jede Zeile der Datei anhand eines regulären Ausdrucks in Teilstrings und übergibt diese jeweils als getrennte Argumente an die Closure.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine lesbare Textdatei bezeichnet.

with Stream(), with Reader(), with Writer()

void withDataInputStream { DataInputStream in -> void }

void withDataOutputStream { DataOutputStream out -> void }

void withInputStream { InputStream in -> void }

void withObjectInputStream { ObjectInputStream in -> void }

void withObjectOutputStream { ObjectOuputStream out -> void }

void withOutputStream { OutputStream out -> void }

void withPrintWriter { PrintWriter out -> void }

void withReader { BufferedReader in -> void }

void withWriter { BufferedWriter out -> void }

void withWriter (String zeichensatz=null) { BufferedWriter out -> void }

void withWriterAppend (String zeichensatz=null) { BufferendWriter out -> void }

Jede dieser Methode erzeugt einen Stream, Reader oder Writer auf der aktuellen Datei und übergibt diesen an die angegebene Closure. Dabei wird sichergestellt, dass die Ein- oder Ausgabe in jedem Fall auch wieder geschlossen wird. Wenn ein Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Kodierung aus dem Inhalt ermittelt. Die Methode withWriterAppend() öffnet die Datei zum Hinzufügen von Daten, alle anderen schreibenden Methoden überschreiben die Datei, wenn sie bereits vorhanden ist.

Diese Methoden setzen voraus, dass das aktuelle File-Objekt eine les- bzw. schreibbare Textdatei bezeichnet.

write()

void write (String text, String zeichensatz=null)

Schreibt den Inhalt des String in die Datei. Wenn der Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Standardkodierung benutzt.

Diese Methode setzt voraus, dass das aktuelle File-Objekt eine schreibbare Datei bezeichnet.

Zu java.io.InputStream

eachByte()

void eachByte { Byte byte -> void }

Ruft die angegebene Closure für jedes Byte des Streams auf. Der Stream wird am Ende geschlossen.

eachLine()

void eachLine { String zeile -> void }

Liest den Stream zeilenweise und ruft mit jeder Zeile die angegebene Closure auf. Verwendet die Standardkodierung. Der Stream wird am Ende geschlossen.

filterLine()

Writable filterLine { String zeile -> boolean }

Erzeugt ein Objekt, das Interface groovy.lang.Writable implementiert und alle Zeilen enthält, für die die angegebene Closure true ergibt.

void filterLine (Writer writer) { String zeile -> boolean }

Schreibt alle Zeilen der Datei in den angegebenen Writer, bei denen der Aufruf der Closure true ergibt.

Beide Methoden schließen den Stream am Ende.

getText()

String getText ()

String getText (String zeichensatz)

Liest den gesamten Inhalt des Stream in einen String. Wenn der Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Standardkodierung benutzt. Der Stream wird danach geschlossen.

iterator()

Iterator<Character> iterator()

Liefert einen Iterator, mit dem die Daten Zeichen für Zeichen gelesen werden können.

newReader()

java.io.BufferedReader newReader()

Erzeugt einen BufferedReader zum Lesen der Daten als Text. Verwendet die Standardkodierung.

readLine()

String readLine()

Liest eine einzelne Textzeile aus dem Stream. Verwendet die Standardkodierung.

readLines()

List<String> readLines()

Liest die gesamten Daten zeilenweise in eine Liste von Strings. Danach wird der Stream geschlossen.

withReader()

void withReader { BufferedReader in -> void }

Erzeugt einen BufferedReader auf dem Stream und übergibt diesen an die angegebene Closure. Dabei wird sichergestellt, dass der Stream in jedem Fall auch wieder geschlossen wird. Es wird die Standardkodierung angewendet.

withStream()

void withStream { InuputStream in -> void }

Übergibt den aktuellen Stream an die Closure und schließt ihn, nachdem sie aufgerufen worden ist.

Zu java.io.ObjectInputStream

eachObject()

void eachObject { Object obj -> void }

Liest den Stream Objekt für Objekt und ruft jeweils die angegebene Closure auf. Der Stream wird am Ende geschlossen.

Zu java.io.OutputStream

leftShift() ‒ Operator <<

Writer leftShift (Object text)

Wandelt das Argument in einen String um und schreibt ihn in den Stream. Es wird die Standardkodierung verwendet. Als Ergebnis wird ein java.io.Writer geliefert, so dass diese Operation auch effizient verkettet werden kann.

OutputStream leftShift (InputStream in)

Leitet den angegebenen InputStream direkt in den OutputStream.

OutputStream leftShift (byte[] value)

Schreibt das byte-Array in den Stream.

withStream()

void withStream { OutputStream out -> void }

Übergibt den aktuellen Stream an die Closure und schließt ihn, nachdem sie aufgerufen worden ist.

withWriter()

void withWriter (String zeichensatz=null) { OutputStreamWriter out -> void }

Erzeugt einen OutputWriter auf dem aktuellen Stream, übergibt ihn an die Closure und schließt ihn, nachdem sie aufgerufen worden ist. Wenn ein Zeichensatz angegeben ist, wird dieser für die Zeichenkodierung verwendet; andernfalls wird die Standardkodierung angewendet.

Zu java.io.Reader

eachLine()

void eachLine { String zeile -> void }

Liest den Reader zeilenweise und ruft mit jeder Zeile die angegebene Closure auf. Der Reader wird am Ende geschlossen.

filterLine()

Writable filterLine { String zeile -> boolean }

Erzeugt ein Objekt, das Interface groovy.lang.Writable implementiert und alle Zeilen enthält, für die die angegebene Closure true ergibt.

void filterLine (Writer writer) { String zeile -> boolean }

Schreibt alle Zeilen der Datei in den angegebenen Writer, bei denen der Aufruf der Closure true ergibt.

Beide Methoden schließen den Stream am Ende.

getText()

String getText ()

Liest den gesamten Inhalt des Readers in einen String. Der Reader wird danach geschlossen.

iterator()

Iterator<String> iterator()

Liefert einen Iterator, mit dem die Daten Zeile für Zeile gelesen werden können.

readLine()

String readLine()

Liest eine einzelne Textzeile aus dem Reader.

readLines()

List<String> readLines()

Liest die gesamten Daten zeilenweise in eine Liste von Strings. Danach wird der Reader geschlossen.

splitEachLine()

void splitEachLine (String regex) { String ... args -> void }

Liest den Reader zeilenweise, zerteilt dabei jede Zeile anhand eines regulären Ausdrucks in Teilstrings und übergibt diese jeweils als getrennte Argumente an die Closure.

transform()

void transformChar (Writer writer) { String einZeichen -> String }

void transformLine (Writer writer) { String eineZeile -> String }

Übergibt jedes aus dem Reader gelesene Zeichen bzw. jede aus dem Reader gelesene Zeile an die Closure und schreibt den Rückgabewert der Closure jeweils in den angegebenen Writer.

withReader()

void withReader { BufferedReader in -> void }

Erzeugt einen BufferedReader auf dem aktuellen Reader und übergibt diesen an die angegebene Closure. Dabei wird sichergestellt, dass der Stream in jedem Fall auch wieder geschlossen wird.

Zu java.io.Writer

leftShift() ‒ Operator <<

Writer leftShift (Object text)

Wandelt das Argument in einen String um und schreibt ihn in den Writer. Als Ergebnis wird der Writer selbst geliefert, so dass diese Operation auch verkettet werden kann.

withWriter()

void withWriter (String zeichensatz=null) { OutputWriter out -> void }

Übergibt den aktuellen Writer übergibt ihn an die Closure. Dabei wird sichergestellt, dass der Stream in jedem Fall auch wieder geschlossen wird.

write()

void write (groovy.lang.Writable writable)

Diese Methode ermöglicht es, dass Objekte, die das Interface groovy.langWritable implementieren, effizient in den Writer geschrieben werden können.

Package java.lang

Zu java.lang.Boolean

and() ‒ Operator: &&

Boolean and (Boolean zweiterWert)

Implementiert den logischen Und-Operator.

or() ‒ Operator: ||

Boolean or (Boolean zweiterWert)

Implementiert den logischen Oder-Operator.

xor()

Boolean xor (Boolean zweiterWert)

Führt die logische exklusive Oder-Operation aus.

Zu java.lang.Byte[]

Siehe auch oben ##Array- und Listenmethoden ##

encodeBase64()

Writable encodeBase64()

Erzeugt ein Objekt, das das Interface groovy.lang.Writable implementiert und den in Base64 kodierten Inhalt des Arrays enthält. Dieser kann über seine Methode write() effizient in einen Writer geschrieben werden. Ein Aufruf von toString() an dem Ergebnis liefert den kodierten Wert als String.

Das Gegenstück zu dieser Methode ist die String-Methode decodeBase64().

Zu java.lang.CharSequence

getAt() ‒ lesender Index-Operator [ ]

CharSequence getAt (int index)

CharSequence getAt (Collection indices)

CharSequence getAt (Range indexIntervall)

Ermöglicht den Zugriff auf String-, StringBuffer- und sonstige Objekte, deren Klassen CharSequence implementieren, wie auf ein Character-Array. Allerdings ist das Ergebnis immer ein Objekt des Originaltyps. Dies gilt auch, wenn als Index eine einzelne Zahl angegeben ist. Der Ausdruck

"abc"[1]

ergibt also nicht etwa eine Character-, sondern eine String-Instanz mit dem Wert "b".

Zu java.lang.Character

Arithmetische Operationen

int compareTo (Number zweiterWert)

int compareTo (Character zweiterWert)

Number div (Number zweiterWert)

Number div (Character zweiterWert)

Number intdiv (Number zweiterWert)

Number intdiv (Character zweiterWert)

Number minus (Number zweiterWert)

Number minus (Character zweiterWert)

Number multiply (Number zweiterWert)

Number multiply (Character zweiterWert)

Number next ()

Number plus (Number zweiterWert)

Number plus (Character zweiterWert)

Number previous ()

Diese Methoden implementieren verschiedene arithmetische Operationen, so dass ein Character-Objekt auf beiden Seiten der entsprechenden Operatoren wie ein ganzzahliger Wert behandelt werden kann. Die Methoden sind unter java.lang.Number im Einzelnen erklärt.

Zu java.lang.Class

getMetaClass()

ExpandoMetaClass getMetaClass ()

Erzeugt eine ExpandoMetaClass zu der aktuellen Klasse, wenn sie nicht bereits existiert, registriert sie bei de MetaClassRegistry und gibt sie als Ergebnis zurück. Die ExpandoMetaClass erlaubt das nachträgliche Definieren von Methoden und Properties zu der aktuellen Klasse.

isCase()

boolean isCase (Object switchValue)

Diese Methode ermöglicht die Verwendung von Klassen und Interfaces in switch-Verzweigungen. Wenn das Argument ebenfalls ein Class-Objekt ist, prüft sie, ob der bezeichnete Typ zuweisungskompatibel zu dem aktuellen Typ ist.

newInstance()

Object newInstance (Object ... args)

Erzeugt eine neue Instanz der aktuellen Klasse durch Aufruf des zu der angegebenen Argumentliste passenden Konstruktors. Nur anwendbar, wenn das aktuelle Class-Objekt eine instanziierbare Klasse benennt.

Zu java.lang.ClassLoader

getRootLoader()

ClassLoader getRootLoader()

Durchsucht den eigenen sowie alle übergeordneten Classloader nach einem Classloader, dessen Name "org.codehaus.groovy.tools.RootLoader" lautet, und liefert diesen als Ergebnis. Wenn ein solcher Classloader nicht gefunden wird, ist das Ergebnis null. Der Root-Loader kann dazu verwendet werden, in einem Skript noch zur Laufzeit der Klassenpfad zu erweitern.

Zu java.lang.Double

Siehe auch die Methoden zu java.lang.Number.

round()

long round()

Rundet auf einen ganzzahligen Wert. Die Rundung wird durch einen Aufruf von java.lang.Math.round() ausgeführt.

Zu java.lang.Float

Siehe auch die Methoden zu java.lang.Number.

round()

long round()

Rundet auf einen ganzzahligen Wert. Die Rundung wird durch einen Aufruf von java.lang.Math.round() ausgeführt.

Zu java.lang.Number

Die Groovy-Laufzeitbibliothek implementiert eine Reihe von arithmetischen Operationen auf dem abstrakten Typ java.lang.Number, die hier erläutert werden. Häufig gibt es Varianten für konkrete numerische Typen, die in dieser Übersicht aber nicht aufgeführt werden, da sie ‒ abgesehen vom Ergebnistyp ‒ keine spezielle Semantik haben.

Diverse arithmetische Operationen sind so definiert, dass auf beiden Seiten des entsprechenden Operators auch ein Character-Objekt stehen kann. Siehe dazu auch die Anmerkung zu Character.

abs()

Number abs()

Liefert den Absolutwert der Zahl.

and() ‒ Operator: &

Number and (Number zweiterWert)

Implementiert die bitweise Und-Operation.

compareTo() ‒ Operatoren: <, <=, >, >=, ==, <=>

int compareTo (Character right)

int compareTo (right)

Implementiert diverse numerische Vergleichsoperatoren.

div() ‒ Operator: /

java.lang.Number div (java.lang.Character right)

java.lang.Number div (java.lang.Number right)

Implementiert den Divisionsoperator.

downto()

void downto (java.lang.Number to) { Number zähler -> void }

Zählt abwärts vom eigenen bis zu dem angegebenen Wert und ruft bei jedem Durchgang die angegebene Closure auf.

intdiv()

java.lang.Number intdiv(java.lang.Character right)

java.lang.Number intdiv(java.lang.Number right)

Führt eine ganzzahlige Division zwischen dem eigenen und dem angegebenen Wert aus.

leftShift ‒ Operator: <<

java.lang.Number leftShift (java.lang.Number anzahl)

Führt eine arithmetische Linksverschiebung um die angegebene Anzahl von Stelle aus. Diese Methode ist nur auf ganzzahlige Typen anwendbar.

minus() ‒ Operator: ‒

java.lang.Number minus (java.lang.Character subtrahend)

java.lang.Number minus(java.lang.Number subtrahend)

Berechnet die Differenz zwischen dem eigenen Wert und dem angegebenen Subtrahenden.

mod() ‒ Operator: %

java.lang.Number mod(java.lang.Number divisor)

Berechnet den Modulo-Wert zwischen dem eigenen Wert und dem angegebenen Divisor.

multiply() ‒ Operator: *

java.lang.Number multiply(java.lang.Character multiplikator)

java.lang.Number multiply(java.lang.Number right)

Berechnet das Produkt aus dem eigenen Wert und dem angegebenen Multiplikator.

negate() ‒ Operator: ~

java.lang.Number negate()

Berechnet den bitweisen Komplementärwert des eigenen Wertes. Diese Methode ist nur auf ganzzahlige Typen anwendbar.

next() ‒ Operator: ++(Post- und Präinkrement)

java.lang.Number next()

Liefert einen um 1 erhöhten Wert.

or() ‒ Operator: |

java.lang.Number or(java.lang.Number zweiterWert)

Führt ein bitweises Oder zwischen dem eigenen und dem angegebenen Wert aus.

plus() ‒ Operator: +

java.lang.Number plus(java.lang.Character summand)

java.lang.Number plus(java.lang.Number summand)

Bildet die Summe aus dem eigenen Wert und dem Argument.

java.lang.String plus(java.lang.String string)

Wenn das Argument ein String ist, wird der aktuelle Wert in einen String umgewandelt und eine Stringverknüpfung mit dem Argument ausgeführt.

power() ‒ Operator: **

java.lang.Number power (java.lang.Number exponent)

Berechnet die Potenz aus dem eigenen Wert und dem angegebenen Exponenten.

previous() ‒ Operator: ‒ ‒(Post- und Prädekrement)

java.lang.Number previous()

Liefert einen um 1 verminderten Wert.

rightShift() ‒ Operator: >>

java.lang.Number rightShift(java.lang.Number right)

Führt eine arithmetische Rechtsverschiebung um die angegebene Anzahl von Stelle aus. Diese Methode ist nur auf ganzzahlige Typen anwendbar.

rightShiftUnsigned() ‒ Operator: >>>

java.lang.Number rightShiftUnsigned(java.lang.Number right)

Führt eine arithmetische Rechtsverschiebung um die angegebene Anzahl von Stellen ohne Berücksichtigung eines Vorzeichens aus. Diese Methode ist nur auf ganzzahlige Typen anwendbar.

step()

void step (Number bis, Number schrittweite) { Number zähler -> void }

Zählt mit der angegebenen Schrittweite bis zu dem Wert bis. Bei jedem Durchgang wird die Closure mit dem jeweiligen Zählerstand aufgerufen. Der Zielwert muss größer als der eigene Wert sein.

times()

void times { Number zähler -> void }

Ruft die Closure entsprechend dem eigenen Wert mehrmals auf, dabei wird der Closure ein bei 0 beginnender ganzzahliger Zähler übergeben.

to()

java.math.BigDecimal toBigDecimal()

java.math.BigInteger toBigInteger()

java.lang.Double toDouble()

java.lang.Float toFloat()

java.lang.Integer toInteger()

java.lang.Long toLong()

Wandelt den aktuellen Wert in ein Objekt des entsprechenden Typs um. Wenn es bereits ein Objekt des Zieltyps ist, wird das aktuelle Objekt selbst zurückgegeben.

upto()

void downto (java.lang.Number to) { Number zähler -> void }

Zählt aufwärts vom eigenen bis zu dem angegebenen Wert und ruft bei jedem Durchgang die angegebene Closure auf.

xor()

java.lang.Number xor(java.lang.Number zweiter Wert)

Führt ein bitweises exklusives Oder zwischen dem eigenen und dem angegebenen Wert aus.

Zu java.lang.Object

Siehe oben, ##Allgemeine Hilfsmethoden## und ##Für alle Objekte geltende Methoden##.

Zu java.lang.Object[]

Siehe auch oben, ##Array- und Listenmethoden##

toArrayString()

java.lang.String toArrayString()

Liefert den Inhalt des Arrays als String, eingeschlossen in geschweifte Klammern.

toSpreadMap()

groovy.lang.SpreadMap toSpreadMap()

Erzeugt eine SpreadMap-Instanz; dabei dienen die Elemente des Arrays abwechselnd als Schlüssel und als Wert eines Map-Eintrags.

toString()

String toString()

Ruft toArrayString() auf und liefert dadurch eine lesbare Form des Array-Inhalts.

Zu java.lang.Process

consumeProcessOutput()

void consumeProcessOutput()

Startet zwei Threads, die asynchron den Standard-Ausgabe und den -Fehlerkanal des Prozesses auslesen, ohne die dabei erhaltenen Daten in irgendeiner Weise zu verarbeiten. Mit Hilfe dieser Methode kann verhindert werden, dass ein Prozess wegen eines vollen Ausgabe-Zwischenspeichers stehen bleibt.

getErr(), getIn(), getOut()

java.io.OutputStream getErr()

java.io.InputStream getIn()

java.io.OutputStream getOut()

Liefert die Standard-Eingabe-, -Ausgabe- und -Fehlerkanäle des Prozesses als Streams. Dies sind einfache Alias-Methoden, die nur da zu dienen, die Streams wie Properties ansprechen zu können.

getText()

java.lang.String getText()

Liest die gesamte Standardausgabe des Prozesses in einen String.

leftShift() ‒ Operator <<

Writer leftShift (Object text)

Wandelt das Argument in einen String um und schreibt ihn die Standardeingabe des Prozesses. Es wird die Standardkodierung verwendet. Als Ergebnis wird ein java.io.Writer geliefert, so dass diese Operation auch effizient verkettet werden kann.

OutputStream leftShift (InputStream in)

Leitet den angegebenen InputStream direkt in den OutputStream.

OutputStream leftShift (byte[] value)

Schreibt das byte-Array in die Standardeingabe des Prozesses.

waitForOrKill()

void waitForOrKill (long numberOfMillis)

Wartet auf die Beendigung des Prozesses und bricht ihn nach Ablauf der angegebenen Anzahl Millisekunden ab.

Zu java.lang.String

Siehe auch java.lang.CharSequence. Die vordefinierten Methoden für Strings haben zum Teil den Zweck, eine ähnliche Behandlung wie bei Listen und Arrays zu ermöglichen. Beachten Sie aber, dass auch hier ‒ wie bei den Methoden zu CharSequence ‒ immer Strings und keine Character-Werte zurückgeliefert werden.

contains()

Boolean contains (String text)

Prüft, ob der aktuelle String den angegebenen String enthält. Diese Methode ist ab Java 5.0 bereits in der Java-Standardbibliothek enthalten.

count()

int count (String s)

Stellt fest, wie oft der als Argument angegebene String in dem aktuellen String vorkommt. Überlappende Teilstrings werden mitgezählt.

decodeBase64()

byte[] decodeBase64 ()

Nimmt an, dass der aktuelle String in Base64 kodierte Daten sind und wandelt diese in ein Byte-Array um. Es gibt eine korrespondierende vordefinierte Methode encodeBase64() für byte-Arrays.

eachMatch()

void eachMatch (String regex, Closure c)

Ruft für jedes Vorkommen des regulären Ausdrucks regex im aktuellen String die angegebene Closure auf. Dabei wird der Closure als Argument jeweils ein String-Array mit den Werten der einzelnen Match-Gruppen übergeben.

execute()

Process execute (String[] env, File dir)

Process execute (List env, File dir)

Process execute ()

Alle drei Methoden führen Inhalt des aktuellen String als Betriebssystembefehl aus. Die Umgebungsvariablen können als String-Array oder String-Liste übergeben werden. Wenn der Parameter dir nicht null ist, enthält er das Arbeitsverzeichnis des zu startenden Prozesses; andernfalls dient das aktuelle Verzeichnis als Arbeitsverzeichnis. Folgendes Beispiel startet unter Windows den Explorer.

"explorer.exe".execute()

getAt() ‒ Operator: [ ](Index lesend)

String getAt (int n)

String getAt (Collection coll)

String getAt (Range r)

Implementiert den Index-Operator für einen einzelnen numerischen Indexwert, für eine Liste von Indexwerten oder für einen Bereich mit Indexwerten. Liefert einen String aus den Zeichen, die sich an den angegebenen Indexwerten befinden. Negative Indexwerte werden dabei vom String-Ende an rückwärts gezählt.

isCase()

Boolean isCase (Object kandidat)

Implementiert die switch-case-Verzweigung. Führt einen String-Vergleich mit kandidat durch.

leftShift() ‒ Operator: <<

StringBuffer leftShift (Object obj)

Wandelt das aktuelle Objekt in einen StringBuffer um, hängt das übergebene Objekt an diesen und übergibt den StringBuffer als Rückgabewert. Da der StringBuffer ebenfalls den Operator << implementiert, können auf diese Weise mehrere String-Verkettungen in einem Stück durchgeführt werden. Das Ergebnis kann dann ohne explizite Umwandlung einem String zugewiesen werden.

minus() ‒ Operator: ‒

String minus (Object obj)

Wandelt das übergebene Objekt in einen String und entfernt dessen erstes Vorkommen aus dem aktuellen String, sofern er in ihm enthalten ist.

multiply() ‒ Operator: *

String multiply (Number n)

Vervielfacht den aktuellen String sooft, wie angegeben. Das Argument wird in eine Ganzzahl umgewandelt und muss größer oder gleich 0 sein. Wenn es 0 ist, wird ein leerer String zurückgegeben.

negate() ‒ Operator: ~

java.util.regex.Pattern negate()

Implementiert den unären Operator ~. Kompiliert den aktuellen String, der einen regulären Ausdruck enthält, zu einem Pattern-Objekt.

next() ‒ Operator: ++(Post- und Präinkrement)

String next()

Erhöht das letzte Zeichen des aktuellen Strings um 1 und liefert das Ergebnis als neues String-Objekt. Wenn das letzte Zeichen gleich Character.MAX_VALUE ist, wird es auf Character.MIN_VALUE gesetzt. Wenn der aktuelle String leer ist, wird Character.MIN_VALUE zurückgegeben.

pad()

String padLeft (Number länge, String füllzeichen=' ')

String padRight (Number länge, String füllzeichen=' ')

Verlängert den aktuellen String auf die angegebene Größe. Bei padLeft() wird er links, bei padRight() wird er rechts, bei Bedarf wiederholt, mit füllzeichen aufgefüllt. Wenn die vorherige Länge bereits größer oder gleich länge ist, bleibt er unverändert. Das Argument füllzeichen muss mindestens ein Zeichen lang sein; standardmäßig dienen Leerzeichen als Füllzeichen.

plus() ‒ Operator: +

String plus (Object obj)

Wandelt das Argument in einen String, hängt diesen an den aktuellen String an und übergibt das Ergebnis als neues String-Objekt.

previous() ‒ Operator: ‒ ‒(Post- und Prädekrement)

String previous ()

Implementiert den unären Operator --. Vermindert das letzte Zeichen des aktuellen Strings um 1 und liefert das Ergebnis als neues String-Objekt. Wenn das letzte Zeichen gleich Character.MIN_VALUE ist, wird es aus dem String entfernt. Der aktuelle String darf nicht leer sein.

replaceAll()

String replaceAll (String regex, Closure c)

Ruft für alle Übereinstimmungen des regulären Ausdrucks regex im aktuellen String die angegebene Closure auf und fügt das jeweilige Ergebnis anstelle des übereinstimmenden String-Abschnitts in den aktuellen String ein. Dabei werden alle Match Gruppen der Reihe nach als Closure-Argumente übergeben.

reverse()

String reverse ()

Gibt eine String mit denselben Zeichen, wie sie im aktuellen String enthalten sind, aber in umgekehrter Reihenfolge zurück.

size()

int size ()

Gibt Anzahl der im aktuellen String enthaltenen Zeichen zurück. Diese Methode ist gleichwertig mit der String-Methode length() und soll einen einheitlichen Zugriff auf die Eigenschaften eines Objekts über verschiedene Typen hinweg ermöglichen.

to()

BigDecimal toBigDecimal ()

BigInteger toBigInteger ()

Boolean toBoolean ()

Character toCharacter ()

Double toDouble ()

Float toFloat ()

Integer toInteger ()

Long toLong ()

Diese Methoden wandeln den aktuellen String in den durch den Methodennamen bezeichneten Typ um. Dazu werden in der Regel die String-Konstruktoren der jeweiligen Zielklassen verwendet.

tokenize()

List tokenize (String trennzeichen=' \t\n\r\f')

Verwandelt den aktuellen String mit Hilfe des java.util.StringTokenizer in eine Liste von Teilstrings. Die in dem als Argument übergebenen String enthaltenen Zeichen dienen dabei als Trennzeichen. Standardmäßig verwendet StringTokenizer Leerzeichen, Tabulator-Zeichen, Zeilenwechsel, Rücklauf- und Seitenwechsel-Zeichen als Trenner.

toList()

List toList ()

Erzeugt eine Liste mit Strings, die jeweils ein einzelnes Zeichen des aktuellen Strings enthalten.

toURI(), toURL()

java.net.URI toURI ()

java.net.URL toURL ()

Wandelt den aktuellen String in ein URI- bzw. ein URL-Objekt.

Zu java.lang.String[]

execute()

java.lang.Process execute()

Führt einen Betriebssystem-Befehl aus. Dabei bildet das erste Array-Element (mit dem Index 0) den eigentlichen Befehl, und die übrigen Elemente werden als Parameter übergeben.

Zu java.lang.StringBuffer

Siehe auch java.lang.CharSequence. Während die Methoden für den Typ String das aktuelle Objekt zwangsläufig nicht verändern können, nehmen folgende Methoden, die für die Klasse java.lang.StringBuffer vordefiniert sind, Modifikationen am aktuellen Objekt vor. Die unsynchronisierte Klasse java.lang.StringBuilder, die ab Java 1.5 in den meisten Fällen anstelle des langsameren StringBuffer verwendet werden kann, wird durch Groovy 1.0 noch nicht unterstützt.

leftShift() ‒ Operator: <<

StringBuffer leftShift (Object obj)

Wandelt das Argument in einen String, hängt ihn an den aktuellen StringBuffer und liefert einen Verweis auf diesen als Ergebnis. Dadurch können mehrere Verkettungsoperationen verknüpft werden. Sie auch die leftShift()-Methode zur Klasse String.

putAt() ‒ Operator: [ ](Index schreibend)

void putAt (IntRange intervall, Object obj)

Implementiert den schreibenden Index-Operator mit einem Intervall. Der durch das Intervall gekennzeichnete Teil des aktuellen StringBuffer wird durch das in einen String umgewandelte zweite Argument ersetzt.

size()

int size ()

Gibt Anzahl der im aktuellen StringBuffer enthaltenen Zeichen zurück. Diese Methode ist gleichwertig mit der StringBuffer-Methode length() und soll einen einheitlichen Zugriff auf die Eigenschaften eines Objekts über verschiedene Typen hinweg ermöglichen.

Package java.net

Zu java.net.ServerSocket

accept()

java.net.Socket accept { Socket socket -> void }

Startet beim Eingang einer neuen Verbindung einen Thread, der die angegebene Closure ausführt. Die Closure erhält die Socket der Verbindung als Argument übergeben. Nachdem die Closure ausgeführt worden ist, wird die Verbindung geschlossen.

Zu java.net.Socket

leftShift() ‒ Operator <<

java.io.Writer leftShift (Object value)

Erzeugt einen Writer auf der Socket und schreibt das Argument als String in den Writer. Der Writer wird als Ergebnis zurückgegeben, sodass die Operation effizient verkettet werden kann.

java.io.OutputStream leftShift (byte[] value)

Erzeugt einen OutputStream auf der Socket und schreibt das Argument in den Stream. Der Stream wird als Ergebnis zurückgegeben, sodass die Operation effizient verkettet werden kann.

withStreams()

void withStreams { InputStream in, OutputStream out -> void }

Erzeugt einen InputStream und einen OutputStream auf der Socket und übergibt beide an die Closure. Beide Streams werden in jedem Fall danach geschlossen.

Zu java.net.URL

eachByte()

void eachByte { Byte byte -> void }

Erzeugt eine Verbindung zu der URL und ruft die angegebene Closure für jedes Byte des Streams auf. Der Stream wird am Ende geschlossen.

eachLine()

void eachLine { String zeile -> void }

Erzeugt eine Verbindung zu der URL, liest dies Zeilenweise und ruft mit jeder Zeile die angegebene Closure auf. Verwendet die Standardkodierung. Der Stream wird am Ende geschlossen.

getText()

String getText ()

String getText (String zeichensatz)

Erzeugt eine Verbindung zu der URL und liest den gesamten Inhalt in einen String. Wenn der Zeichensatz angegeben ist, wird dieser für die Kodierung verwendet, andernfalls wird die Standardkodierung benutzt. Der Stream wird danach geschlossen.

withReader()

void withReader { BufferedReader in -> void }

Erzeugt einen BufferedReader zum Lesen der URL und übergibt diesen an die angegebene Closure. Dabei wird sichergestellt, dass der Reader in jedem Fall auch wieder geschlossen wird. Es wird die Standardkodierung angewendet.

Package java.sql

Zu java.sql.Date

Siehe java.utilDate

Package java.util

Zu java.util.Collection

Siehe auch oben, ##Iterative Methoden ##

asImmutable()

java.util.Collection asImmutable()

Übergibt die Collection als unveränderbare Collection.

asList()

java.util.List asList()

Erzeugt eine neue List-Instanz mit dem Inhalt der Collection. Wenn die Collection bereits eine Liste ist, wird sie selbst zurückgegeben.

asSynchronized()

java.util.Collection asSynchronized()

Übergibt die Collection als synchronisierte (Thread-sichere) Collection.

count()

int count (Object value)

Zählt, wie viele Elemente gleich dem Argument sind.

disjoint()

boolean disjoint(java.util.Collection right)

Prüft, ob sich die aktuelle und die als Argument übergebene Collection nicht überschneiden, also keine gleichen Elemente haben.

getAt() ‒ Operator: [ ](Index lesend)

java.util.List getAt (String property)

Durchläuft alle Elemente der Collection, fragt bei jedem Element die Property mit dem angegebenen Namen ab und liefert eine Liste mit den Werten dieser Properties.

groupBy()

java.util.Map<Object,List> groupBy { Object element -> Object }

Gruppiert die Elemente der Collection entsprechend den Ergebnissen, die jeder Aufruf der Closure liefert.

intersect()

java.util.List intersect (java.util.Collection zweiteCollection)

Erstellt eine Liste mit allen Elementen, die sowohl in der aktuellen als auch in der als Argument übergebenen Collection vorkommen.

isCase()

boolean isCase(java.lang.Object kandidat)

Implementiert die switch-case-Verzweigung. Prüft, ob kandidat in der aktuellen Collection enthalten ist..

leftShift ‒ Operator: <<

java.util.Collection leftShift (Object value)

Fügt das Argument der aktuellen Collection hinzu. Die aktuelle Collection wird als Ergebnis zurückgeliefert, so dass sich die Operation leicht verketten lässt.

max()

Object max()

Object max(java.util.Comparator comparator)

Object max { Object element -> Object }

Object max { Object e1, Object e2 > int }

Liefert den größten Wert in der Collection. Wenn ein Comparator angegeben ist, wird dieser für den Vergleich verwendet. Wenn eine Closure angegeben ist, wird diese für den Vergleich verwendet. Hat die Closure einen Parameter, so wird das Ergebnis der Closure für den Vergleich verwendet. Hat sie zwei Parameter, so muss sie einen Vergleich zwischen diesen beiden Objekten durchführen und das Ergebnis liefert (‒1, 0, +1). Bei der Argumentlosen Variante von max() wird ein typspezifischer Vergleich durchgeführt.

min()

Object min()

Object min(java.util.Comparator comparator)

Object min { Object element -> Object }

Object min { Object e1, Object e2 > int }

Liefert den kleinsten Wert in der Collection. Wenn ein Comparator angegeben ist, wird dieser für den Vergleich verwendet. Wenn eine Closure angegeben ist, wird diese für den Vergleich verwendet. Hat die Closure einen Parameter, so wird das Ergebnis der Closure für den Vergleich verwendet. Hat sie zwei Parameter, so muss sie einen Vergleich zwischen diesen beiden Objekten durchführen und das Ergebnis liefert (‒1, 0, +1). Bei der Argumentlosen Variante von min() wird ein typspezifischer Vergleich durchgeführt.

multiply() ‒ Operator: *

List multiply (Number faktor)

Erzeugt eine Liste, in der alle Elemente der Collection mehrfach entsprechend dem angegebenen Faktor mehrfach vorhanden sind.

plus() ‒ Operator: +

Collection plus (Collection right)

Collection plus (Object right)

Erzeugt eine neue Collection, in der die Elemente der aktuellen Collection sowie das Argument bzw. ‒ wenn das Argument ebenfalls eine Collection ist ‒ die Elemente des Arguments enthalten sind. Wenn das aktuelle Objekt ein Set ist, ist auch das Ergebnis ein Set. Andernfalls ist das Ergebnis eine Liste.

sort()

List sort()

List sort(java.util.Comparator comparator)

List sort { Object element -> Object }

List sort { Object e1, Object e2 > int }

Liefert eine Liste, in der die Elemente der aktuellen Collection sortiert enthalten sind. Wenn ein Comparator angegeben ist, wird dieser für den Vergleich verwendet. Wenn eine Closure angegeben ist, wird diese für den Vergleich verwendet. Hat die Closure einen Parameter, so wird das Ergebnis der Closure für den Vergleich verwendet. Hat sie zwei Parameter, so muss sie einen Vergleich zwischen diesen beiden Objekten durchführen und das Ergebnis liefert (‒1, 0, +1). Bei der Argumentlosen Variante von sort() wird ein typspezifischer Vergleich durchgeführt.

Wenn die aktuelle Collection ein SortedSet ist, wird sie selbst als Ergebnis geliefert, denn in diesem Fall ist das Sortieren überflüssig.

sum()

Object sum()

java.lang.Object sum { (groovy.lang.Closure closure)

Summiert die Elemente der Collection. Wenn alle Elemente Zahlen sind, werden sie arithmetisch addiert, andernfalls werden alle Element in Strings umgewandelt und zusammengefügt.

Wenn eine Closure angegeben ist, werden nicht die Elemente der Collection sonder die Ergebniswerte der Closure-Aufrufe für jedes Element summiert.

toList()

List toList()

Liefert eine neue Liste mit allen Elementen der Collection.

toListString()

String toListString()

Liefert den Inhalt der Collection als String, eingeschlossen in eckige Klammern.

toString()

String toString()

Ruft toListString() auf und liefert dadurch eine lesbare Form des Inhalts.

unique()

Collection unique()

Collection unique (java.util.Comparator comparator)

Collection unique { Object element -> Object }

Collection unique { Object e1, Object e2 > int }

Erzeugt eine neue Collection aus den Elementen der aktuellen Collection, in der alle doppelten Elemente entfernt sind. Wenn ein Comparator angegeben ist, wird dieser für den Vergleich verwendet. Wenn eine Closure angegeben ist, wird diese für den Vergleich verwendet. Hat die Closure einen Parameter, so wird das Ergebnis der Closure für den Vergleich verwendet. Hat sie zwei Parameter, so muss sie einen Vergleich zwischen diesen beiden Objekten durchführen und das Ergebnis liefert (‒1, 0, +1). Bei der Argumentlosen Variante von unique() wird ein typspezifischer Vergleich durchgeführt.

Wenn die aktuelle Collection ein Set ist, wird sie selbst als Ergebnis geliefert (ein Set kann keine doppelten Elemente enthalten.)

Zu java.util.Date

Alle für java.util.Date vordefinierten Methoden sind auch auf java.sql.Date anwendbar.

minus() ‒ Operator: ‒

Date minus(int days)

Subtrahiert die angegebene Anzahl von Tagen und gibt das Ergebnis als neues Date-Objekt zurück.

next() ‒ Operator: ++(Post- und Präinkrement)

Date next()

Erhöht das Datum um einen Tag und gibt das Ergebnis als neues Date-Objekt zurück.

plus() ‒ Operator: +

Date plus(int days)

Addiert die angegebene Anzahl von Tagen und gibt das Ergebnis als neues Date-Objekt zurück.

previous() ‒ Operator: ‒ ‒(Post- und Präinkrement)

Date previous()

Vermindert das Datum um einen Tag und gibt das Ergebnis als neues Date-Objekt zurück.

Zu java.util.Enumeration

iterator()

java.util.Iterator iterator()

Liefet einen Iterator über die Elemente der Enumeration. Damit können die iterativen Methoden und die for-Schleife auch auf Enumerationen angewendet werden.

Zu java.util.Iterator

iterator()

java.util.Iterator iterator()

Liefet den Iterator selbst als Ergebnis. Damit können die iterativen Methoden und die for-Schleife auch direkt auf Iteratoren angewendet werden.

Zu java.util.List

java.util.List asImmutable()

asImmutable()

List asImmutable()

Übergibt die Liste als unveränderbare liste.

asSynchronized()

Map asSynchronized()

Übergibt die Liste als synchronisierte (Thread-sichere) Liste.

execute()

Process execute()

Führt einen Betriebssystem-Befehl aus. Dabei bildet das erste Listenelement (mit dem Index 0) den eigentlichen Befehl, und die übrigen Elemente werden als Parameter übergeben.

flatten()

List flatten()

Erzeugt eine neue Liste, die alle Elemente der aktuellen Liste enthält, dabei werden diejenigen Elemente, die Collections oder Maps sind, rekursive durch deren einzelne Elemente ersetzt.

minus()

List minus (Object operand)

List minus (Collection zuEntfernen)

Entfernt alle Elemente, die gleich dem Argument bzw. gleich einem in dem Argument enthaltenen Element sind, aus der aktuellen Liste und übergibt das Ergebnis als neue Liste.

pop()

Object pop()

Entfernt das letzte Element aus der Liste und übergibt es als Ergebnis. Dadurch lässt sich jede Liste wie ein Stack behandeln.

putAt() ‒ Oparator: [ ] (Index schreibend)

void putAt (Range range, Object value)

Entfernt die durch den Bereich indizierten Elemente aus der Liste und ersetzt sie durch das zweite Argument. Wenn letzteres eine Collection ist, werden stattdessen die Elemente dieser Collection einzeln eingefügt.

reverse()

List reverse()

Erzeugt eine neue Liste, die dieselben Elemente wie die aktuelle Liste enthält, jedoch in umgekehrter Reihenfolge.

reverseEach()

void reverseEach { Object element -> void }

Durchläuft alle Elemente der Liste in umgekehrter Reihenfolge und übergibt sie jeweils der Closure.

Zu java.util.Map

asImmutable()

Map asImmutable()

Übergibt die Map als unveränderbare Map. Wenn die aktuelle Map eine SortedMap ist, ist auch das Ergebnis eine SortedMap.

asSynchronized()

Map asSynchronized()

Übergibt die Map als synchronisierte (Thread-sichere) Map. Wenn die aktuelle Map eine SortedMap ist, ist auch das Ergebnis eine SortedMap.

asType() ‒ Operator: as

<T> T asType (Class<T> interface)

Diese Methode ermöglicht es, ein mit der aktuellen Map ein beliebiges Interface dynamisch zu implementieren. Alle Methodenaufrufe an dem resultierenden Objekt werden in Aufrufe von Closures umgewandelt, die unter dem Namen der Methode in der Map gespeichert sein müssen.

collect()

List collect { Map.Entry entry -> Object }

List collect (List list) { Map.Entry entry -> Object }

List collect { Object key, Object value -> Object }

List collect (List list) { Object key, Object value -> Object }

Liefert eine Collection aus den Ergebnissen, die von der angegebenen Closure bei dem Aufruf für jedes Element geliefert werden. Wenn eine Liste als Argument übergeben worden ist, werden die Closure-Ergebnisse zu dieser hinzugefügt, andernfalls legt die Methode ein neues List-Objekt an.

Wenn die Closure einen Parameter hat, wird ihr der jeweilige Map-Eintrag übergeben, andernfalls erhält sie den Schlüssel und den Wert als einzelne Argumente übergeben.

each()

void each { Map.Entry entry -> Object }

void each { Object key, Object value -> Object }

Führt die angegebene Closure für jedes Element aus. Wenn die Closure einen Parameter hat, wird ihr der jeweilige Map-Eintrag übergeben, andernfalls erhält sie den Schlüssel und den Wert als einzelne Argumente übergeben.

find()

Object find { Object elementwert -> boolean }

Ermittelt das erste Element, für das die angegebene Closure true ergibt. Der Closure werden die Werte der Map übergeben, nicht die Schlüssel.

findAll()

Map findAll { Map.Entry eintrag -> boolean }

Map findAll { Objekt schlüssel, Objekt wert -> boolean }

Erzeugt eine neue Map aus allen Elementen, für die der Closure-Aufruf true ergibt. Wenn die Closure einen Parameter hat, wird ihr der jeweilige Map-Eintrag übergeben, andernfalls erhält sie den Schlüssel und den Wert als einzelne Argumente übergeben.

get()

Object get (Object schlüssel, Object vorgabeWert)

Zusätzliche Variante der bei Maps ohnehin vorhandenen get()-Methode. Wenn in der Map kein Wert mit dem angegebenen Schlüssel vorhanden ist, wird stattdessen der angegebenen Vorgabewert geliefert.

getAt() ‒ Operator: [ ](Index lesend)

Object getAt (Object schlüssel)

Leitet den Aufruf an die normale get()-.Methode der Map weiter. Diese Methode ermöglicht es, die Werte einer Map auch mit der Index-Notation (eckige Klammern) auszulesen.

putAt() ‒ Operator: [ ](Index schreibend)

Object putAt (Object schlüssel, Object wert)

Leitet den Aufruf an die normale put()-.Methode der Map weiter. Diese Methode ermöglicht es, die Werte einer Map auch mit der Index-Notation (eckige Klammern) zu setzen.

spread()

groovy.lang.SpreadMap spread()

Erzeugt eine java.lang.SpreadMap mit dem Inhalt der aktuellen Map.

subMap()

Map subMap (Collection schlüssel)

Erzeugt eine neue Map, in der alle Werte der aktuellen Map umfasst, deren Werte in der als Argument erhaltenen Collection vorkommen.

toMapString()

String toMapString()

Liefert den Inhalt der Map als String, eingeschlossen in eckigen Klammern.

toSpreadMap()

groovy.lang.SpreadMap toSpreadMap()

Erzeugt eine java.lang.SpreadMap mit dem Inhalt der aktuellen Map.

toString()

String toString()

Ruft toMapString() auf und liefert dadurch eine lesbare Form des Inhalts.

Zu java.util.Set

asImmutable()

Set asImmutable()

Übergibt das Set als unveränderbares Set. Wenn das aktuelle Set ein SortedSet ist, ist auch das Ergebnis ein SortedSet.

asSynchronized()

Set asSynchronized()

Übergibt das Set als synchronisiertes (Thread-sicheres) Set. Wenn das aktuelle Set ein SortedSet ist, ist auch das Ergebnis ein SortedSet.

flatten()

List flatten()

Erzeugt ein neues Set, das alle Elemente des aktuellen Set enthält, dabei werden diejenigen Elemente, die Collections oder Maps sind, rekursive durch deren einzelne Elemente ersetzt.

minus()

Set minus (Object operand)

Set minus (Collection zuEntfernen)

Entfernt alle Elemente, die gleich dem Argument bzw. gleich einem in dem Argument enthaltenen Element sind, aus dem aktuellen Set und übergibt das Ergebnis als neues Set.

Zu java.util.Timer

runAfter()

void runAfter (int millis) { null -> void }

Beauftragt den Timer, die angegebene Closure nach einer bestimmten Anzahl von Millisekunden auszuführen.

Package java.util.regex

Zu java.util.regex.Matcher

each()

void each { String[] matchgroups -> void }

Durchläuft alle Treffer eines Mustervergleichs. Der Closure werden jeweils die einzelnen Match-Gruppen al s Argumente übergeben.

getAt() ‒ Operator: [ ](Index lesend)

Object getAt (int index)

Liefert den Treffer mit dem angegebenen Index aus einem Mustervergleich. Bei einem einfachen Vergleichsmuster ist das Ergebnis ein String, bei einem gruppierten Vergleichsmuster ist das Ergebnis eine Liste mit Match-Gruppen.

String getAt (Collection indices)

Liefert die Treffer min den angegebenen Indices aus einem Mustervergleich als verketteten String. Die Elemente der Collection können einzelne Index-Zahlen; in diesem Fall werden die gesamten Übereinstimmungen hinzugefügt. Es können aber auch ihrerseits wieder Collections oder Intervalle sein; dann werden die entsprechenden Match-Gruppen jedes Treffers hinzugefügt.

getCount()

int getCount()

Liefert die Anzahl der Übereinstimmungen nach einem Mustervergleich.

hasGroup()

boolean hasGroup()

Prüft, ob der Matcher Gruppierungen enthält.

iterator()

java.util.Iterator<String> iterator()

Liefet einen Iterator über die Treffer des Mustervergleichs Damit können die iterativen Methoden und die for-Schleife auch auf Matcher angewendet werden.

setIndex()

void setIndex (int index)

Setzt die Position des Matcher auf den angegebenen Index.

size()

long size()

Liefert die Anzahl der Übereinstimmungen nach einem Mustervergleich.

Zu java.util.regex.Pattern

isCase()

boolean isCase (Object kandidat)

Implementiert die switch-case-Verzweigung. Prüft, ob der Mustervergleich zwischen kandidat in dem aktuellen Pattern ein positives Ergebnis hat.

Package org.w3c.dom

Zu org.w3c.dom.NodeList

iterator()

java.util.Iterator iterator()

Liefet einen Iterator über die NodeList. Damit können die iterativen Methoden und die for-Schleife auch auf NodeList angewendet werden.

← Groovy im Entwicklungsprozess | ↑ Inhalt | → Anhang - Wichtige Klassen und Interfaces