Package com.github.muehmar.gradle.openapi.generator.java.model.type

Interface JavaType

All Known Implementing Classes:
BaseJavaType, JavaAnyType, JavaArrayType, JavaBooleanType, JavaEnumType, JavaIntegerType, JavaMapType, JavaNumericType, JavaObjectType, JavaStringType, NonGenericJavaType
public interface JavaType

  • Method Details

    • wrap

      static JavaType wrap(Type type, TypeMappings typeMappings)

    • getQualifiedClassName

      QualifiedClassName getQualifiedClassName()
      Returns the qualified classname of the java type used internally in the DTO for serialization and validation.

    • getApiType

      Optional<ApiType> getApiType()
      Returns the ApiType of this JavaType, not for possible generics. I.e. it returns also an empty Optional in case the JavaType itself has no ApiType but it has generics with an ApiType.

    • hasApiTypeDeep

      default boolean hasApiTypeDeep()
      Returns true if the JavaType or any possible generics have an ApiType.

    • hasNoApiTypeDeep

      default boolean hasNoApiTypeDeep()
      Returns false if neither the JavaType nor any possible generics have an ApiType.

    • getAllQualifiedClassNames

      PList<QualifiedClassName> getAllQualifiedClassNames()
      Returns the qualified classnames used for this type, including the classes of possible type parameters as well as possible api types.

    • getNullability

      Nullability getNullability()

    • withNullability

      JavaType withNullability(Nullability nullability)

    • getParameterizedClassName

      ParameterizedClassName getParameterizedClassName()
      Returns the parameterized classname of the java type used internally.

    • getParameterizedApiClassName

      default Optional<ParameterizedApiClassName> getParameterizedApiClassName()
      Returns the parameterized API classname of the java type if it has an api type.

    • getWriteableParameterizedClassName

      default WriteableParameterizedClassName getWriteableParameterizedClassName()
      Returns a writeable parameterized classname which gets rendered as api type if any or as normal type if not.

    • isJavaArray

      boolean isJavaArray()
      Returns true in case this class is a java array (not to be confused with the openapi array-type).

    • getConstraints

      Constraints getConstraints()

    • fold

      <T> T fold(Function<JavaArrayType,T> onArrayType, Function<JavaBooleanType,T> onBooleanType, Function<JavaEnumType,T> onEnumType, Function<JavaMapType,T> onMapType, Function<JavaAnyType,T> onAnyType, Function<JavaNumericType,T> onNumericType, Function<JavaIntegerType,T> onIntegerType, Function<JavaObjectType,T> onObjectType, Function<JavaStringType,T> onStringType)

    • onArrayType

      default Optional<JavaArrayType> onArrayType()

    • isArrayType

      default boolean isArrayType()

    • isNullableContainerValueType

      default boolean isNullableContainerValueType()

    • isNullableItemsArrayType

      default boolean isNullableItemsArrayType()

    • isNullableValuesMapType

      default boolean isNullableValuesMapType()

    • onMapType

      default Optional<JavaMapType> onMapType()

    • isMapType

      default boolean isMapType()

    • isAnyType

      default boolean isAnyType()

    • isIntegerType

      default boolean isIntegerType()

    • isNumericType

      default boolean isNumericType()

    • isContainerType

      default boolean isContainerType()
      Returns true if this type is a container type, i.e. a list or a map.

    • getImports

      default PList<QualifiedClassName> getImports()

    • getImportsAsString

      default PList<String> getImportsAsString()