Java-Klasse oder -Typ erstellen

Mit dem Dialogfeld Neuen Kurs erstellen und den Dateivorlagen in Android Studio können Sie schnell die folgenden neuen Klassen und Typen erstellen:

• Java-Klassen
• Aufzählungs- und Singleton-Klassen
• Schnittstellen- und Anmerkungstypen

Nachdem Sie die Dialogfelder Create New Class (Neue Klasse erstellen) ausgefüllt und auf OK geklickt haben, erstellt Android Studio eine .java-Datei mit Skeletal-Code, einschließlich einer Paketanweisung, aller erforderlichen Importe, eines Headers und einer Klassen- oder Typdeklaration. Fügen Sie dieser Datei nun Ihren Code hinzu.

Dateivorlagen geben an, wie Android Studio den Skelettcode generiert. Sie können die mit Android Studio bereitgestellten Dateivorlagen unverändert verwenden oder an Ihren Entwicklungsprozess anpassen.

Dateivorlagen aufrufen und anpassen

Android Studio bietet Dateivorlagen, die festlegen, wie neue Java-Klassen und ‑Typen mit dem Dialogfeld Neue Klasse erstellen erstellt werden. Sie können diese Vorlagen anpassen.

Abbildung 1 Das Dialogfeld Neuen Kurs erstellen.

Die Android Studio-Dateivorlagen enthalten Velocity Template Language-Code (VTL) und Variablen, die diese zusätzlichen Optionen verarbeiten. Im Dialogfeld Neue Klasse erstellen werden die Dateivorlagen AnnotationType, Class, Enum, Interface und Singleton verwendet.

So rufen Sie die Vorlagen auf, suchen nach Anpassungen und ändern die Vorlagen:

1. Führen Sie einen der folgenden Schritte aus:

   • Wählen Sie unter Windows oder Linux Datei > Einstellungen > Editor > Datei- und Codevorlagen > Dateien aus.
   • Wählen Sie unter macOS Android Studio > Einstellungen > Editor > Datei- und Codevorlagen > Dateien aus.

   In der Vorlagenliste sind interne Vorlagennamen fett formatiert. Namen benutzerdefinierter Vorlagen werden in einer hervorgehobenen Farbe wie Blau angezeigt.

2. Passen Sie die Dateivorlagen nach Bedarf an.

   Wenn Sie die Dialogfelder Create New Class (Neue Klasse erstellen) verwenden möchten, müssen Ihre Änderungen dem Android Studio-Dateivorlagecode entsprechen.

Weitere Informationen zu Dateivorlagen, einschließlich VTL, finden Sie unter Datei- und Codevorlagen und Dialogfeld „Datei- und Codevorlagen“.

Java-Klasse oder -Typ erstellen

Android Studio unterstützt Sie beim Erstellen neuer Java-Klassen, Enumerations- und Singleton-Klassen sowie Interface- und Anmerkungstypen anhand von Dateivorlagen.

So erstellen Sie eine neue Java-Klasse oder einen neuen Java-Typ:

1. Klicken Sie im Fenster Project (Projekt) mit der rechten Maustaste auf eine Java-Datei oder einen Java-Ordner und wählen Sie New (Neu) > Java Class (Java-Klasse) aus.

Alternativ können Sie im Fenster Projekt eine Java-Datei oder einen Java-Ordner auswählen oder im Code-Editor auf eine Java-Datei klicken. Wählen Sie dann Datei > Neu > Java-Klasse aus.

Das ausgewählte Element bestimmt das Standardpaket für die neue Klasse oder den neuen Typ.

2. Füllen Sie im Dialogfeld Neue Klasse erstellen die folgenden Felder aus:
• Name: Der Name der neuen Klasse oder des neuen Typs. Er muss den Java-Namenanforderungen entsprechen. Geben Sie keine Dateiendung ein.
• Kind: Wählen Sie die Kategorie der Klasse oder den Typ aus.
• Superklasse: Die Klasse, von der Ihre neue Klasse erbt. Sie können den Paket- und Klassennamen oder nur den Klassennamen eingeben und dann in der Drop-down-Liste auf ein Element doppelklicken, um es automatisch zu vervollständigen.
• Schnittstellen: Eine oder mehrere Schnittstellen, die die neue Klasse oder der neue Typ implementiert. Trennen Sie mehrere Oberflächen durch ein Komma, gefolgt von einem optionalen Leerzeichen. Sie können den Namen des Pakets und der Benutzeroberfläche oder nur den Namen der Benutzeroberfläche eingeben und dann in der Drop-down-Liste doppelt auf ein Element klicken, um es automatisch vervollständigen zu lassen.

Die automatische Vervollständigung funktioniert nur für den ersten Schnittstellennamen. Hinweis: Das Komma und der folgende Interface-Name können zwar einen Tippfehler hervorrufen, Sie können ihn aber ignorieren, da er sich nicht auf den generierten Code auswirkt.

• Paket: Das Paket, in dem sich die Klasse oder der Typ befindet. Der Standardwert wird automatisch im Feld angezeigt. Wenn Sie einen Paketnamen in das Feld eingeben, werden alle nicht vorhandenen Teile der Paket-ID rot hervorgehoben. In diesem Fall erstellt Android Studio das Paket, nachdem Sie auf OK geklickt haben. Dieses Feld muss einen Wert enthalten. Andernfalls enthält die Java-Datei keine package-Anweisung und die Klasse oder der Typ wird nicht in ein Paket im Projekt aufgenommen.

Die Standardeinstellung hängt davon ab, wie Sie das Dialogfeld Neuen Kurs erstellen geöffnet haben. Wenn Sie zuerst eine Java-Datei oder einen Java-Ordner im Fenster Projekt ausgewählt haben, ist das Paket für das ausgewählte Element standardmäßig ausgewählt. Wenn Sie zuerst auf eine Java-Datei im Code-Editor geklickt haben, ist das Paket, das diese Datei enthält, standardmäßig ausgewählt.

• Sichtbarkeit: Wählen Sie aus, ob die Klasse oder der Typ für alle Klassen oder nur für die im eigenen Paket sichtbar sein soll.
• Modifikatoren: Wählen Sie den Modifikator Abstrakt oder Abschließend für eine Klasse aus oder lassen Sie beide Modifikatoren deaktiviert.
• Dialogfeld „Überschreibungen auswählen“ anzeigen: Wenn Sie für eine Art von Klasse diese Option aktivieren, wird nach dem Klicken auf OK das Dialogfeld Methoden zum Überschreiben/Implementieren auswählen geöffnet. In diesem Dialogfeld können Sie Methoden auswählen, die Sie überschreiben oder implementieren möchten. Android Studio generiert dann Skeletal-Code für diese Methoden.

Felder, die sich nicht auf das Kind beziehen, sind ausgeblendet.

3. Klicken Sie auf OK.

Android Studio erstellt eine Java-Datei mit Skeletal-Code, den Sie ändern können. Die Datei wird im Code-Editor geöffnet.

Hinweis:Sie können eine Singleton-Klasse erstellen, indem Sie Datei > Neu > Singleton oder Datei > Neu > Java-Klasse auswählen. Letzteres bietet mehr Optionen.

Android Studio-Dateivorlagen

In diesem Abschnitt wird der Android Studio-Dateivorlagecode in der Scripting-Sprache VTL aufgeführt, gefolgt von Definitionen der Variablen. Die Werte, die Sie im Dialogfeld Neuen Kurs erstellen angeben, werden zu den Variablenwerten in der Vorlage. Die Zeilen, die mit #if (${VISIBILITY} beginnen, reichen bis zur öffnenden Klammer ({).

Dateivorlage für AnnotationType

#if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#if (${IMPORT_BLOCK} != "")${IMPORT_BLOCK}
#end
#parse("File Header.java")

#if (${VISIBILITY} == "PUBLIC")public #end @interface ${NAME} #if (${INTERFACES} != "")extends ${INTERFACES} #end {
}

Vorlage für Kursdateien

#if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#if (${IMPORT_BLOCK} != "")${IMPORT_BLOCK}
#end
#parse("File Header.java")

#if (${VISIBILITY} == "PUBLIC")public #end #if (${ABSTRACT} == "TRUE")abstract #end #if (${FINAL} == "TRUE")final #end class ${NAME} #if (${SUPERCLASS} != "")extends ${SUPERCLASS} #end #if (${INTERFACES} != "")implements ${INTERFACES} #end {
}

Vorlage für Enum-Dateien

#if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#if (${IMPORT_BLOCK} != "")${IMPORT_BLOCK}
#end
#parse("File Header.java")

#if (${VISIBILITY} == "PUBLIC")public #end enum ${NAME} #if (${INTERFACES} != "")implements ${INTERFACES} #end {
}

Vorlage für Interfacedateien

#if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#if (${IMPORT_BLOCK} != "")${IMPORT_BLOCK}
#end
#parse("File Header.java")

#if (${VISIBILITY} == "PUBLIC")public #end enum ${NAME} #if (${INTERFACES} != "")implements ${INTERFACES} #end {
#end {
}

Singleton-Dateivorlage

#if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#if (${IMPORT_BLOCK} != "")${IMPORT_BLOCK}
#end
#parse("File Header.java")

#if (${VISIBILITY} == "PUBLIC")public #end class ${NAME} #if (${SUPERCLASS} != "")extends ${SUPERCLASS} #end #if (${INTERFACES} != "")implements ${INTERFACES} #end {
    private static final ${NAME} ourInstance = new ${NAME}();

    #if (${VISIBILITY} == "PUBLIC")public #end static ${NAME} getInstance() {
        return ourInstance;
    }

    private ${NAME}() {
    }
}

Variablen für Dateivorlagen

Android Studio ersetzt die Variablen der Dateivorlage durch Werte in der generierten Java-Datei. Geben Sie die Werte im Dialogfeld Neuen Kurs erstellen ein. Die Vorlage enthält die folgenden Variablen, die Sie verwenden können:

• IMPORT_BLOCK: Eine durch neue Zeilen getrennte Liste von Java-import-Anweisungen, die zur Unterstützung einer Superklasse oder Schnittstelle erforderlich sind, oder ein leerer String (""). Wenn Sie beispielsweise nur die Runnable-Schnittstelle implementieren und nichts erweitern, hat diese Variable den Wert "import java.lang.Runnable;\n". Wenn Sie die Schnittstelle Runnable implementieren und die Klasse Activity erweitern, wird sie "import android.app.Activity;\nimportjava.lang.Runnable;\n".
• VISIBILITY – Gibt an, ob der Kurs öffentlich zugänglich ist oder nicht. Sie kann den Wert PUBLIC oder PACKAGE_PRIVATE haben.
• SUPERCLASS: Ein einzelner Kursname oder leer. Falls vorhanden, folgt nach dem Namen der neuen Klasse eine extends ${SUPERCLASS}-Klausel.
• INTERFACES: Eine durch Kommas getrennte Liste von Schnittstellen oder eine leere Liste. Falls vorhanden, steht nach der Superklasse eine implements ${INTERFACES}-Klausel oder nach dem Klassennamen, wenn es keine Superklasse gibt. Bei Schnittstellen und Anmerkungstypen haben die Schnittstellen das Keyword extends.
• ABSTRACT – Gibt an, ob die Klasse abstrakt sein soll oder nicht. Sie kann den Wert TRUE oder FALSE haben.
• FINAL – Gibt an, ob der Kurs endgültig sein soll oder nicht. Sie kann den Wert TRUE oder FALSE haben.