Java-Klasse oder -Typ erstellen

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

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

Nachdem Sie die Dialogfelder unter Create New Class ausgefüllt und auf OK geklickt haben, erstellt Android Studio eine .java-Datei mit dem Gerüstcode, einschließlich einer Paketdeklaration, aller erforderlichen Importe, eines Headers und einer Klassen- oder Typdeklaration. Anschließend können Sie dieser Datei Ihren Code hinzufügen.

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

Dateivorlagen ansehen und anpassen

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

Abbildung 1. Das Dialogfeld Neuen Kurs erstellen.

Die Android Studio-Dateivorlagen enthalten VTL-Code (Velocity Template Language) 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 File > Settings > Editor > File and Code Templates > Files (Datei > Einstellungen > Editor > Datei- und Codevorlagen > Dateien) aus.
   • Wählen Sie unter macOS Android Studio > Preferences > Editor > File and Code Templates > Files aus.

   In der Vorlagenliste werden interne Vorlagennamen fett dargestellt. Benutzerdefinierte Vorlagennamen werden in einer Hervorhebungsfarbe wie Blau angezeigt.

2. Passen Sie die Dateivorlagen nach Bedarf an.

   Wenn Sie die Dialogfelder Create New Class verwenden möchten, müssen Ihre Änderungen dem Android Studio-Dateivorlagencode entsprechen.

Weitere Informationen zu Dateivorlagen, einschließlich VTL, finden Sie unter File and Code Templates (Dateivorlagen und Codevorlagen) und File and Code Templates Dialog (Dialogfeld „Dateivorlagen und Codevorlagen“).

Java-Klasse oder -Typ erstellen

Mit Android Studio können Sie neue Java-Klassen, Enumerations- und Singleton-Klassen sowie Schnittstellen- und Annotationstypen basierend auf Dateivorlagen erstellen.

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 Project 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 Felder aus:
• Name: Der Name der neuen Klasse oder des neuen Typs. Er muss den Java-Namensanforderungen entsprechen. Geben Sie keine Dateiendung ein.
• Art: Wählen Sie die Kategorie des Kurses oder Typs aus.
• Superclass: 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 von der neuen Klasse oder dem neuen Typ implementiert werden. Mehrere Schnittstellen sollten durch ein Komma gefolgt von einem optionalen Leerzeichen getrennt werden. Sie können den Paket- und Schnittstellennamen oder nur den Schnittstellennamen eingeben und dann doppelt auf ein Element in der Drop-down-Liste klicken, um es automatisch zu vervollständigen.

Die automatische Vervollständigung funktioniert nur für den ersten Schnittstellennamen. Beachten Sie, dass das Komma und der folgende Schnittstellenname möglicherweise einen Tooltip-Fehler verursachen. Sie können den Fehler jedoch 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 Teile der Paket-ID, die nicht vorhanden sind, 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 einem Paket im Projekt platziert.

Der Standardwert hängt davon ab, wie Sie das Dialogfeld Neuen Kurs erstellen aufgerufen haben. Wenn Sie zuerst eine Java-Datei oder einen Java-Ordner im Fenster Project (Projekt) ausgewählt haben, ist das Standardpaket das Paket für das ausgewählte Element. Wenn Sie zuerst im Code-Editor auf eine Java-Datei geklickt haben, wird standardmäßig das Paket verwendet, das diese Datei enthält.

• Sichtbarkeit: Wählen Sie aus, ob die Klasse oder der Typ für alle Klassen oder nur für die Klassen im eigenen Paket sichtbar sein soll.
• Modifizierer: Wählen Sie den Modifizierer Abstract oder Final für eine Klasse aus oder lassen Sie das Feld leer.
• Dialogfeld „Überschreibungen auswählen“ anzeigen: Wenn Sie für Art die Option Klasse auswählen, aktivieren Sie diese Option, um das Dialogfeld „Zu überschreibende/implementierende Methoden auswählen“ zu öffnen, nachdem Sie auf OK geklickt haben. In diesem Dialogfeld können Sie Methoden auswählen, die Sie überschreiben oder implementieren möchten. Android Studio generiert dann den Gerüstcode für diese Methoden.

Alle Felder, die nicht für die Art gelten, sind ausgeblendet.

3. Klicken Sie auf OK.

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

Hinweis:Sie können eine Singleton-Klasse erstellen, indem Sie File > New > Singleton oder File > New > Java Class auswählen. Die zweite Methode bietet mehr Optionen.

Android Studio-Dateivorlagen

In diesem Abschnitt wird der in der Scripting-Sprache VTL geschriebene Android Studio-Dateivorlagencode aufgeführt, gefolgt von Definitionen der Variablen. Die Werte, die Sie im Dialogfeld Create New Class (Neue Klasse erstellen) angeben, werden zu den Variablenwerten in der Vorlage. Die Zeilen, die mit #if (${VISIBILITY} beginnen, erstrecken sich bis zur geschweiften Klammer auf ({).

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 {
}

Kursdateivorlage

#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 {
}

Enum-Dateivorlage

#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 {
}

Vorlagendatei für die Schnittstelle

#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 Variablen in Dateivorlagen 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 Zeilenumbrüche getrennte Liste von Java-import-Anweisungen, die zur Unterstützung von Superklassen oder Schnittstellen erforderlich sind, oder ein leerer String (""). Wenn Sie beispielsweise nur die Runnable-Schnittstelle implementieren und nichts erweitern, ist diese Variable "import java.lang.Runnable;\n". Wenn Sie die Schnittstelle Runnable implementieren und die Klasse Activity erweitern, ist sie "import android.app.Activity;\nimportjava.lang.Runnable;\n".
• VISIBILITY – Gibt an, ob die Klasse öffentlich zugänglich ist. Sie kann den Wert PUBLIC oder PACKAGE_PRIVATE haben.
• SUPERCLASS – Ein einzelner Klassenname oder leer. Falls vorhanden, wird nach dem Namen der neuen Klasse eine extends ${SUPERCLASS}-Klausel angezeigt.
• INTERFACES: Eine durch Kommas getrennte Liste von Schnittstellen oder leer. Falls vorhanden, folgt nach der Superklasse oder nach dem Klassennamen (wenn es keine Superklasse gibt) eine implements ${INTERFACES}-Klausel. Bei Schnittstellen und Annotationstypen haben die Schnittstellen das Keyword extends.
• ABSTRACT: Gibt an, ob die Klasse abstrakt sein soll. Sie kann den Wert TRUE oder FALSE haben.
• FINAL: Gibt an, ob die Klasse final sein soll. Sie kann den Wert TRUE oder FALSE haben.