Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AnnotationEnumJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation
-
AnnotationEnumJsonSerializeris aJsonSerializerforEnums declared insideAnnotations that useAnnotationJsonName. - AnnotationEnumJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationEnumJsonSerializer
- AnnotationJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation
-
AnnotationJsonSerializeris aJsonSerializerforAnnotationthat uses reflection to invoke theClass.getDeclaredMethods()of theAnnotation.annotationType()and uses reflection to handlenet.jacobpeterson.jet.openapiannotations.meta. - AnnotationJsonSerializer(Set) - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer
-
Creates a new
AnnotationJsonSerializerinstance. - 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
- 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
aJsonObjectorJsonArraywith the givenbJsonObjectorJsonArrayinto a newJsonObjectorJsonArray.
E
- EmptyStringIsNullJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.string
-
EmptyStringIsNullJsonSerializeris aStringJsonSerializerthat treatsString.isEmpty()asJsonNull. - EmptyStringIsNullJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.string.EmptyStringIsNullJsonSerializer
- EnumSerializedNameCustomDefinitionProvider - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson
-
EnumSerializedNameCustomDefinitionProvideris aCustomDefinitionProviderV2to supportSerializedNameonEnumfields. - 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"
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
- getAnnotatedClasspaths() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
For the
JetOpenApiAnnotationsTask, the classpath files to load into aClassLoaderthat should be scanned forOpenApiannotations. - getAnnotatedClasspaths() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getClasspaths() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
For the
JetOpenApiAnnotationsTask, the classpaths to load into aClassLoaderfor dependency classes used in fields thatOpenApiSchema.fromClass(). - getClasspaths() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- 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 totrueto, if not already provided, generateOpenApiOperation.operationId()by concatenatingOpenApiPathItem.methods()with the lower-camelcase conversion of the path segments ofOpenApiPathItem.MapEntry.key()after the index ofOpenApiOperation.tags(). - getGenerateOperationId() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getMoveClassSchemasToComponents() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
For the
JetOpenApiAnnotationsTask, set totrueto move the JSON schema generated fromOpenApiSchema.fromClass()toOpenApiComponents.schemas(), set tofalseotherwise. - getMoveClassSchemasToComponents() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getOutputDirectory() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
The
JetOpenApiAnnotationsTaskoutput directory. - getOutputDirectory() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getOutputDirectoryIncludeInJar() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
Set to
trueto include theJetOpenApiAnnotationsExtension.getOutputDirectory()in eachJarTask, set tofalseotherwise. - getSchemaGeneratorConfigBuilderProvider() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
- getSchemaGeneratorConfigBuilderProvider() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getSchemaGeneratorSimpleTypeMappings() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
For the
JetOpenApiAnnotationsTask, aMapcontaining 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
- getSchemaGeneratorUseGsonModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getSchemaGeneratorUseJacksonModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
For the
JetOpenApiAnnotationsTask, set totrueto use theJacksonSchemaModule, set tofalseotherwise. - getSchemaGeneratorUseJacksonModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getSchemaGeneratorUseNullableModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
For the
JetOpenApiAnnotationsTask, set totrueto use theNullableSchemaModule, set tofalseotherwise. - getSchemaGeneratorUseNullableModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getSchemaGeneratorUseSchemaNameModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
For the
JetOpenApiAnnotationsTask, set totrueto use theSchemaNameSchemaModule, set tofalseotherwise. - getSchemaGeneratorUseSchemaNameModule() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getSchemaValidation() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
-
For the
JetOpenApiAnnotationsTask, set totrueto validate the OpenAPI specification JSON output generated fromOpenApiannotations using supported OpenAPI JSON schemas (seeOpenApipublic constants starting with$SCHEMA_), set tofalseotherwise. - getSchemaValidation() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
- getTracerClasses() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer
-
The
SetofAnnotationClasses to insert aAnnotationJsonSerializer.JSON_KEY_CLASS_TRACERproperty into the serializedJsonObjectwith the value ofClass.getCanonicalName(). - GsonSchemaModule - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson
- GsonSchemaModule() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.gson.GsonSchemaModule
- GsonUtil - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson
-
GsonUtilis a utility class forGson.
H
- HeaderJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum
- HeaderJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum.HeaderJsonSerializer
J
- JetOpenApiAnnotationsExtension - Class in net.jacobpeterson.jet.openapiannotationsplugin
-
JetOpenApiAnnotationsExtensionis a Gradle extension forJetOpenApiAnnotationsPlugin. - JetOpenApiAnnotationsExtension() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension
- JetOpenApiAnnotationsPlugin - Class in net.jacobpeterson.jet.openapiannotationsplugin
- JetOpenApiAnnotationsPlugin() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsPlugin
- JetOpenApiAnnotationsTask - Class in net.jacobpeterson.jet.openapiannotationsplugin
- 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__"
M
- MethodJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.commonenum
- 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
-
NullableSchemaModuleis aModulethat usesNullableUtil.isFieldNullable(Field)forSchemaGeneratorConfigPart.withRequiredCheck(Predicate). - NullableSchemaModule() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.nullable.NullableSchemaModule
O
- OpenApiPathItemJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation
- OpenApiPathItemJsonSerializer() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.OpenApiPathItemJsonSerializer
- OpenApiSchemaJsonSerializer - Class in net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation
- 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
- removeTracerClasses(JsonObject) - Static method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer
-
Removes all
AnnotationJsonSerializer.JSON_KEY_CLASS_TRACERkeys from the givenJsonObjectusingGsonUtil.walk(JsonElement, Function). - run() - Method in class net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsTask
S
- SchemaGeneratorConfigBuilderProvider - Interface in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator
-
SchemaGeneratorConfigBuilderProvideris aFunctionalInterfaceto provide aSchemaGeneratorConfigBuilder. - SchemaGeneratorUtil - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator
-
SchemaGeneratorUtilis a utility class forSchemaGenerator. - SchemaNameDefinitionNamingStrategy - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname
- SchemaNameDefinitionNamingStrategy() - Constructor for class net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname.SchemaNameDefinitionNamingStrategy
- SchemaNameSchemaModule - Class in net.jacobpeterson.jet.openapiannotationsplugin.schemagenerator.module.schemaname
- 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(Enum, Type, JsonSerializationContext) - Method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationEnumJsonSerializer
- 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(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() - 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"
W
- walk(JsonElement, Function) - Static method in class net.jacobpeterson.jet.openapiannotationsplugin.gson.GsonUtil
-
Walks the given
JsonElementtree using recursion.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form