Package de.svws_nrw.transpiler.typescript

Enum-Klasse ApiMimeType

java.lang.Object

java.lang.Enum<ApiMimeType>

de.svws_nrw.transpiler.typescript.ApiMimeType

Alle implementierten Schnittstellen:

Serializable, Comparable<ApiMimeType>, Constable

public enum ApiMimeType
extends Enum<ApiMimeType>

Diese Aufzählung beinhaltet alle Mime-Types, die derzeit vom Transpiler für die OpenAPI unterstützt werden.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum-Konstanten - Übersicht

Enum-Konstanten

Enum-Konstante	Beschreibung
APPLICATION_JSON	JSON
APPLICATION_OCTET_STREAM	Binary Data
MULTIPART_FORM_DATA	Multipart Form Data
PDF	PDF
SQLITE	SQlite-Database
TEXT_PLAIN	Plain Text
ZIP	PDF

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static List<ApiMimeType>	fromClassTree(Transpiler transpiler, ClassTree classTree, String annotation)	Bestimmt die Mime-Types, welche durch die angebene Annotation bei einer Klasse spezifiziert wurden.
static List<ApiMimeType>	fromMethodTree(Transpiler transpiler, MethodTree methodTree, String annotation)	Bestimmt die Mime-Types, welche durch die angebene Annotation bei einer Methode spezifiziert wurden.
static ApiMimeType	get(String str)	Ermittelt anhand der übergebenen Zeichenkette den Mime-Type aus dieser Aufzählung.
String	toString()
static ApiMimeType	valueOf(String name)	Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
static ApiMimeType[]	values()	Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.

Von Klasse geerbte Methoden java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Von Klasse geerbte Methoden java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum-Konstanten - Details

TEXT_PLAIN

public static final ApiMimeType TEXT_PLAIN

Plain Text

APPLICATION_JSON

public static final ApiMimeType APPLICATION_JSON

JSON

MULTIPART_FORM_DATA

public static final ApiMimeType MULTIPART_FORM_DATA

Multipart Form Data

APPLICATION_OCTET_STREAM

public static final ApiMimeType APPLICATION_OCTET_STREAM

Binary Data

SQLITE

public static final ApiMimeType SQLITE

SQlite-Database

PDF

public static final ApiMimeType PDF

PDF

ZIP

public static final ApiMimeType ZIP

PDF

Methodendetails

values

public static ApiMimeType[] values()

Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.

Gibt zurück:

ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration

valueOf

public static ApiMimeType valueOf(String name)

Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück. Die Zeichenfolge muss exakt mit einer ID übereinstimmen, mit der eine Enum-Konstante in dieser Klasse deklariert wird. (Zusätzliche Leerzeichen sind nicht zulässig.)

Parameter:

name - Name der zurückzugebenden Enumerationskonstante.

Gibt zurück:

Enumerationskonstante mit dem angegebenen Namen

Löst aus:

IllegalArgumentException - wenn diese Enum-Klasse keine Konstante mit dem angegebenen Namen enthält

NullPointerException - wenn das Argument nicht angegeben wird

get

public static ApiMimeType get(String str)

Ermittelt anhand der übergebenen Zeichenkette den Mime-Type aus dieser Aufzählung. Hierbei kann sowohl der MimeType übergeben werden oder auch die Konstante der Klasse MediaType.

Parameter:

str - die Zeichenkette mit dem Mime-Type

Gibt zurück:

das Element dieser Aufzählung

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Enum<ApiMimeType>

fromClassTree

public static List<ApiMimeType> fromClassTree(Transpiler transpiler,
 ClassTree classTree,
 String annotation)

Bestimmt die Mime-Types, welche durch die angebene Annotation bei einer Klasse spezifiziert wurden.

Parameter:

transpiler - der für die Analyse zu verwendende Transpiler

classTree - die Java-API-Klasse

annotation - die Annotation

Gibt zurück:

die Mime-Types oder eine leere Liste, falls die Annotation keine Mime-Types spezifiziert

fromMethodTree

public static List<ApiMimeType> fromMethodTree(Transpiler transpiler,
 MethodTree methodTree,
 String annotation)

Bestimmt die Mime-Types, welche durch die angebene Annotation bei einer Methode spezifiziert wurden.

Parameter:

transpiler - der für die Analyse zu verwendende Transpiler

methodTree - die Java-API-Methode

annotation - die Annotation

Gibt zurück:

die Mime-Types oder eine leere Liste, falls die Annotation keine Mime-Types spezifiziert