dk.mada.jaxrs.generator.mpclient.dto.tmpl.CtxDto Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-jaxrs-client Show documentation
A JAXRS client generator
There is a newer version: 0.11.8
package dk.mada.jaxrs.generator.mpclient.dto.tmpl;

import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.SortedSet;

import org.immutables.value.Value.Immutable;
import org.jspecify.annotations.Nullable;

import io.jstach.jstache.JStache;

/**
 * Context passed to Mustache when compiling a model.
 */
@JStache(path = "model")
@Immutable
public interface CtxDto {
    /** {@return a builder for this type} */
    static ImmutableCtxDto.Builder builder() {
        return ImmutableCtxDto.builder();
    }

    /** {@return the application name} */
    String appName();

    /** {@return the application version} */
    String version();

    /** {@return the optional application description} */
    Optional appDescription();

    /** {@return the optional application contact email} */
    Optional infoEmail();

    /** {@return the imports needed in the template} */
    SortedSet getImports();

    /** {@return true if there are imports to render, otherwise false} */
    default boolean hasImports() {
        return !getImports().isEmpty();
    }

    /** {@return the optional description of the class} */
    Optional description();

    /** {@return the package name for the class} */
    String packageName();

    /** {@return the classname for the class} */
    String classname();

    /** {@return the class name used in equals method} */
    String classVarName();

    /** {@return the properties of the class} */
    List vars();

    /** {@return true if there are properties to render, otherwise false} */
    default boolean hasVars() {
        return !vars().isEmpty();
    }

    /** {@return true if this is an enumeration, otherwise false} */
    default boolean isEnum() {
        return allowableValues() != null;
    }

    /** {@return true if this DTO should be rendered as a record} */
    boolean isRecord();

    /** {@return the enumeration constants/values, or null} */
    @Nullable CtxEnum allowableValues();

    /** {@return the data type of an enumeration, or null} */
    @Nullable String dataType();

    /** {@return unknown, kept from upstream template} */
    @Nullable String datatypeWithEnum();

    /** {@return true if the is an enumeration that can be deserialized as null} */
    boolean isNullable();

    /** {@return the optional name of a parent class} */
    Optional parent();

    // jspecify @Nullable does not work here, for some reason
    /** {@return optional vendor extensions} */
    @javax.annotation.Nullable Map vendorExtensions();

    /** {@return true if a jackson serializer is used, otherwise false} */
    boolean jackson();

    /** {@return the name of the Generated annotation class} */
    String generatedAnnotationClass();

    /** {@return the name of the generator class} */
    String generatorClass();

    /** {@return the optional date of the generation} */
    Optional generatedDate();

    /** {@return an optional discriminator for sub-class selection} */
    Optional discriminator();

    /** {@return additional custom template data for the dto} */
    CtxDtoExt madaDto();
}