Package de.svws_nrw.transpiler.typescript

Klasse ApiClassAnnotations

java.lang.Object

de.svws_nrw.transpiler.typescript.ApiClassAnnotations

public class ApiClassAnnotations
extends Object

Diese Klasse analysiert den Java-Code einer OpenAPI-Klasse und stellt die Informationen für den Transpiler zur Verfügung.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
final List<ApiMimeType>	consumes	Der Mime-Type, welcher für den Input der API-Methoden als Standard gilt, sofern dort kein anderer Wert gesetzt wird.
final String	path	Der Pfad, der als Basis-Pfad für alle Methoden dieser API-Klasse dient.
final List<ApiMimeType>	produces	Der Mime-Type, welcher für alle Ergebnisse der API-Methoden als Standard gilt, sofern dort kein anderer Wert gesetzt wird.
final String	tag	Der Name der API

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ApiClassAnnotations(Transpiler transpiler, ClassTree classTree)	Erstellt eine neue Übersicht über die Klassen-Annoationen für das Erstellen der TypeScript-Client-API

Methodenübersicht

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

tag

public final String tag

Der Name der API

path

public final String path

Der Pfad, der als Basis-Pfad für alle Methoden dieser API-Klasse dient.

produces

public final List<ApiMimeType> produces

Der Mime-Type, welcher für alle Ergebnisse der API-Methoden als Standard gilt, sofern dort kein anderer Wert gesetzt wird.

consumes

public final List<ApiMimeType> consumes

Der Mime-Type, welcher für den Input der API-Methoden als Standard gilt, sofern dort kein anderer Wert gesetzt wird.

Konstruktordetails

ApiClassAnnotations

public ApiClassAnnotations(Transpiler transpiler,
 ClassTree classTree)

Erstellt eine neue Übersicht über die Klassen-Annoationen für das Erstellen der TypeScript-Client-API

Parameter:

transpiler - der für die Analyse zu verwendende Transpiler

classTree - die zu analysierende Java-API-Klasse