Index (openapi-annotations-plugin 3.1.1 API)

A B C D E F G H J M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ANNOTATION_METHOD_CLASS_NAME_DELIMITER - Static variable in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer: The delimiter as described by AnnotationJsonSerializer.CURRENT_ANNOTATION_METHOD: "#"
AnnotationJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation: AnnotationJsonSerializer is a JsonSerializer for Annotation that uses reflection to invoke the Class.getDeclaredMethods() of the Annotation.annotationType() and uses reflection to handle SerializedName, AnnotationJsonIgnore, AnnotationJsonSerializeEmptyArray, AnnotationJsonObjectInline, AnnotationArrayIsNullableValue, AnnotationJsonRawString, AnnotationArrayIsMap, and AnnotationArrayIsMapKey.
AnnotationJsonSerializer(Set) - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer: Creates a new AnnotationJsonSerializer instance.
apply(Project) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsPlugin
applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson.GsonSchemaModule
applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.nullable.NullableSchemaModule
applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname.SchemaNameSchemaModule

B

BOTH - Enum constant in enum class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension.GenerateOperationId: If not already provided, generate OpenApiOperation.operationId() using the JetOpenApiAnnotationsExtension.GenerateOperationId.FROM_CLASS_METHOD_NAME configuration and ensuring the generated value is equal to the generated value of the JetOpenApiAnnotationsExtension.GenerateOperationId.FROM_METHOD_AND_PATH configuration.
BUILD_OUTPUT_DEFAULT_DIRECTORY_NAME - Static variable in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsPlugin: The build output default directory name JetOpenApiAnnotationsTask.getOutputDirectory(): "jet-openapi-annotations"

C

combine(JsonElement, JsonElement) - Static method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.GsonUtil: Recursively combines the given a JsonObject or JsonArray with the given b JsonObject or JsonArray into a new JsonObject or JsonArray.
CURRENT_ANNOTATION_METHOD - Static variable in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer: The ThreadLocal Method of the current Annotation being serialized.

D

DISABLED - Enum constant in enum class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension.GenerateOperationId: Do not generate OpenApiOperation.operationId().

E

EmptyStringIsNullJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.string: EmptyStringIsNullJsonSerializer is a String JsonSerializer that treats String.isEmpty() as JsonNull.
EmptyStringIsNullJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.string.EmptyStringIsNullJsonSerializer
EnumSerializedNameCustomDefinitionProvider - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson: EnumSerializedNameCustomDefinitionProvider is a CustomDefinitionProviderV2 to support SerializedName on Enum fields.
EnumSerializedNameCustomDefinitionProvider() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson.EnumSerializedNameCustomDefinitionProvider
EXTENSION_NAME - Static variable in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsPlugin: The name used for JetOpenApiAnnotationsExtension: "jetOpenApiAnnotations"

F

FROM_CLASS_METHOD_NAME - Enum constant in enum class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension.GenerateOperationId: If not already provided, generate OpenApiOperation.operationId() using the name of the class method annotated with the OpenApi annotation.
FROM_METHOD_AND_PATH - Enum constant in enum class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension.GenerateOperationId: If not already provided, generate OpenApiOperation.operationId() by concatenating OpenApiPathItem.methods() with the lower-camelcase conversion of the path segments of OpenApiPathItem.MapEntry.key() after the index of OpenApiOperation.tags().

G

generateSchemaToGson(SchemaGenerator, Type, Type...) - Static method in class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.SchemaGeneratorUtil
generateSchemaToGsonAndInlineSingleSimpleTypeDef(SchemaGenerator, Type, Type...) - Static method in class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.SchemaGeneratorUtil
getDefinitionNameForKey(DefinitionKey, SchemaGenerationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname.SchemaNameDefinitionNamingStrategy
getGenerateOperationId() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: For the JetOpenApiAnnotationsTask, set the JetOpenApiAnnotationsExtension.GenerateOperationId configuration.
getGenerateOperationId() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getJavaCompileTasks() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: The JavaCompile tasks that are used to read compiled class files and classpaths from in JetOpenApiAnnotationsTask.
getJavaCompileTasks() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getMoveClassSchemasToComponents() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: For the JetOpenApiAnnotationsTask, set to true to move the JSON schema generated from OpenApiSchema.fromClass() to OpenApiComponents.schemas(), set to false otherwise.
getMoveClassSchemasToComponents() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getOpenApisOfMethods() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.OpenApiJsonSerializer: A Map of OpenApi annotations mapped to their annotated Method used to set AnnotationJsonSerializer.CURRENT_ANNOTATION_METHOD.
getOutputDirectory() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: The JetOpenApiAnnotationsTask output directory.
getOutputDirectory() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getOutputDirectoryIncludeInJar() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: Set to true to include the JetOpenApiAnnotationsExtension.getOutputDirectory() in each Jar Task, set to false otherwise.
getSchemaGeneratorConfigBuilderProvider() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: The SchemaGeneratorConfigBuilderProvider for the JetOpenApiAnnotationsTask.
getSchemaGeneratorConfigBuilderProvider() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getSchemaGeneratorSimpleTypeMappings() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: For the JetOpenApiAnnotationsTask, a Map containing simple type mappings with the fully qualified class name as the key and the raw JSON schema as the value.
getSchemaGeneratorSimpleTypeMappings() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getSchemaGeneratorUseGsonModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: For the JetOpenApiAnnotationsTask, set to true to use GsonSchemaModule the, set to false otherwise.
getSchemaGeneratorUseGsonModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getSchemaGeneratorUseJacksonModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: For the JetOpenApiAnnotationsTask, set to true to use the JacksonSchemaModule, set to false otherwise.
getSchemaGeneratorUseJacksonModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getSchemaGeneratorUseNullableModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: For the JetOpenApiAnnotationsTask, set to true to use the NullableSchemaModule, set to false otherwise.
getSchemaGeneratorUseNullableModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getSchemaGeneratorUseSchemaNameModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: For the JetOpenApiAnnotationsTask, set to true to use the SchemaNameSchemaModule, set to false otherwise.
getSchemaGeneratorUseSchemaNameModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getSchemaValidation() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension: For the JetOpenApiAnnotationsTask, set to true to validate the OpenAPI specification JSON output generated from OpenApi annotations using the OpenApi.DEFAULT_$SCHEMA, set to false otherwise.
getSchemaValidation() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
getTracerClasses() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer: The Set of Annotation Classes to insert a AnnotationJsonSerializer.JSON_KEY_CLASS_TRACER property into the serialized JsonObject with the value of Class.getCanonicalName().
GsonSchemaModule - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson: GsonSchemaModule is a Module that supports the Gson Expose and SerializedName annotations.
GsonSchemaModule() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson.GsonSchemaModule
GsonUtil - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson: GsonUtil is a utility class for Gson.

H

HeaderJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum: HeaderJsonSerializer is a JsonSerializer for Header.
HeaderJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum.HeaderJsonSerializer

J

JetOpenApiAnnotationsExtension - Class in net.jacobpeterson.jet.openapiannotationsplugin: JetOpenApiAnnotationsExtension is a Gradle extension for JetOpenApiAnnotationsPlugin.
JetOpenApiAnnotationsExtension() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
JetOpenApiAnnotationsExtension.GenerateOperationId - Enum Class in net.jacobpeterson.jet.openapiannotationsplugin: JetOpenApiAnnotationsExtension.GenerateOperationId is an enum for JetOpenApiAnnotationsExtension.getGenerateOperationId().
JetOpenApiAnnotationsPlugin - Class in net.jacobpeterson.jet.openapiannotationsplugin: JetOpenApiAnnotationsPlugin is Project Plugin for OpenApi annotations.
JetOpenApiAnnotationsPlugin() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsPlugin
JetOpenApiAnnotationsTask - Class in net.jacobpeterson.jet.openapiannotationsplugin: JetOpenApiAnnotationsTask is the DefaultTask for JetOpenApiAnnotationsPlugin.
JetOpenApiAnnotationsTask() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
JSON_KEY_CLASS_TRACER - Static variable in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer: The JSON key name for AnnotationJsonSerializer.getTracerClasses(): "__AnnotationJsonSerializer.JSON_KEY_CLASS_TRACER__"
JSON_KEY_METHOD_TRACER - Static variable in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer: The JSON key name for AnnotationJsonSerializer.CURRENT_ANNOTATION_METHOD: "__AnnotationJsonSerializer.JSON_KEY_METHOD_TRACER__"

M

MethodJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum: MethodJsonSerializer is a JsonSerializer for Method.
MethodJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum.MethodJsonSerializer

N

net.jacobpeterson.jet.openapiannotationsplugin - package net.jacobpeterson.jet.openapiannotationsplugin
net.jacobpeterson.jet.openapiannotationsplugin.gson - package net.jacobpeterson.jet.openapiannotationsplugin.gson
net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation - package net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation
net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum - package net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum
net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.string - package net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.string
net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator - package net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator
net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson - package net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson
net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.nullable - package net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.nullable
net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname - package net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname
NullableSchemaModule - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.nullable: NullableSchemaModule is a Module that uses NullableUtil.isFieldNullable(Field) for SchemaGeneratorConfigPart.withRequiredCheck(Predicate).
NullableSchemaModule() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.nullable.NullableSchemaModule

O

OpenApiJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation: OpenApiJsonSerializer is a JsonSerializer for OpenApi.
OpenApiJsonSerializer(Map) - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.OpenApiJsonSerializer: Creates a new OpenApiJsonSerializer instance.
OpenApiPathItemJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation: OpenApiPathItemJsonSerializer is a JsonSerializer for OpenApiPathItem.
OpenApiPathItemJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.OpenApiPathItemJsonSerializer
OpenApiSchemaJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation: OpenApiSchemaJsonSerializer is a JsonSerializer for OpenApiSchema.
OpenApiSchemaJsonSerializer(SchemaGenerator) - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.OpenApiSchemaJsonSerializer

P

provide() - Method in interface net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.SchemaGeneratorConfigBuilderProvider
provideCustomSchemaDefinition(ResolvedType, SchemaGenerationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson.EnumSerializedNameCustomDefinitionProvider

R

removeTracers(JsonObject) - Static method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer: Removes all AnnotationJsonSerializer.JSON_KEY_CLASS_TRACER and AnnotationJsonSerializer.JSON_KEY_METHOD_TRACER keys from the given JsonObject.
run() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask

S

SchemaGeneratorConfigBuilderProvider - Interface in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator: SchemaGeneratorConfigBuilderProvider is a FunctionalInterface to provide a SchemaGeneratorConfigBuilder.
SchemaGeneratorUtil - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator: SchemaGeneratorUtil is a utility class for SchemaGenerator.
SchemaNameDefinitionNamingStrategy - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname: SchemaNameDefinitionNamingStrategy is a SchemaDefinitionNamingStrategy that uses SchemaNameUtil.getFullSchemaName(Class).
SchemaNameDefinitionNamingStrategy() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname.SchemaNameDefinitionNamingStrategy
SchemaNameSchemaModule - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname: SchemaNameSchemaModule is a Module that sets SchemaGeneratorGeneralConfigPart.withDefinitionNamingStrategy(SchemaDefinitionNamingStrategy) to SchemaNameDefinitionNamingStrategy.
SchemaNameSchemaModule() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname.SchemaNameSchemaModule
serialize(Annotation, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer
serialize(String, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.string.EmptyStringIsNullJsonSerializer
serialize(Header, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum.HeaderJsonSerializer
serialize(Method, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum.MethodJsonSerializer
serialize(Status, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum.StatusJsonSerializer
serialize(OpenApiPathItem, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.OpenApiPathItemJsonSerializer
serialize(OpenApi, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.OpenApiJsonSerializer
serialize(OpenApiSchema, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.OpenApiSchemaJsonSerializer
StatusJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum: StatusJsonSerializer is a JsonSerializer for Status.
StatusJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum.StatusJsonSerializer

T

TASK_NAME - Static variable in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsPlugin: The name used for JetOpenApiAnnotationsTask: "jetOpenApiAnnotations"

V

valueOf(String) - Static method in enum class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension.GenerateOperationId: Returns the enum constant of this class with the specified name.
values() - Static method in enum class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension.GenerateOperationId: Returns an array containing the constants of this enum class, in the order they are declared.

W

walk(JsonElement, Function) - Static method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.GsonUtil: Recursively walks the given JsonElement tree.

A B C D E F G H J M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form