com.palantir.conjure.java.Options Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of conjure-java-core Show documentation
Palantir open source project
There is a newer version: 8.36.0
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.conjure.java;

import com.google.common.annotations.Beta;
import com.palantir.conjure.java.services.JerseyServiceGenerator;
import com.palantir.conjure.java.types.ObjectGenerator;
import java.util.Optional;
import org.immutables.value.Value;

@Value.Immutable
public interface Options {

    /**
     * Instructs the {@link JerseyServiceGenerator} to generate binary response endpoints with the
     * {@code javax.ws.rs.core.Response} type.
     */
    @Value.Default
    default boolean jerseyBinaryAsResponse() {
        return false;
    }

    /**
     * Instructs the {@link JerseyServiceGenerator} to add {@link javax.validation.constraints.NotNull} annotations to all auth parameters, as well
     * as all non-optional body params on service endpoints.
     */
    @Value.Default
    default boolean requireNotNullAuthAndBodyParams() {
        return false;
    }

    /** Undertow generated service interfaces are generated with an "Undertow" prefix. */
    @Value.Default
    default boolean undertowServicePrefix() {
        return false;
    }

    /** Use the conjure immutable "Bytes" class over ByteBuffer. */
    @Value.Default
    default boolean useImmutableBytes() {
        return false;
    }

    /**
     * Instructs the {@link com.palantir.conjure.java.services.UndertowServiceGenerator} to generate service endpoints
     * returning {@link com.google.common.util.concurrent.ListenableFuture} to allow asynchronous request processing.
     */
    @Value.Default
    default boolean undertowListenableFutures() {
        return false;
    }

    /**
     * Allows synchronous and {@link com.google.common.util.concurrent.ListenableFuture} based asynchronous request
     * handling to be mixed in a single module using {@link com.palantir.conjure.spec.EndpointDefinition#getMarkers()}.
     * This feature is experimental and subject to change.
     */
    @Beta
    @Value.Default
    default boolean experimentalUndertowAsyncMarkers() {
        return false;
    }

    /**
     * Instructs the {@link ObjectGenerator} to not generate objects that fail to deserialize if unknown fields are
     * encountered.
     */
    @Value.Default
    default boolean strictObjects() {
        return false;
    }

    /**
     * Instructs the code generator, when generating JAX-RS classes to generate them with the jakarta.
     * prefix instead of the legacy jaxrs. prefix. At the moment for backwards compatibility
     * this is default false, with the intention that when enough adoption has occurred that this will become
     * default true in the future.
     */
    @Value.Default
    default boolean jakartaPackages() {
        return false;
    }

    /**
     * Instructs the {@link ObjectGenerator} to generate objects that fail to deserialize collections with null values.
     */
    @Value.Default
    default boolean nonNullCollections() {
        return false;
    }

    /**
     * Instructs the service generator to use top-level collections that fail to deserialize collections with null
     * values.
     */
    @Value.Default
    default boolean nonNullTopLevelCollectionValues() {
        return nonNullCollections();
    }

    /**
     * Generates compile-time safe builders to ensure all attributes are set, except those of type list, set, map, or
     * optional. If {@link Options#useStrictStagedBuilders} is true, this option is ignored.
     */
    @Value.Default
    default boolean useStagedBuilders() {
        return false;
    }

    /**
     * Generates compile-time safe builders to ensure all attributes are set.
     */
    @Value.Default
    default boolean useStrictStagedBuilders() {
        return false;
    }

    /**
     * Generated objects which exclude fields with empty optional values.
     */
    @Value.Default
    default boolean excludeEmptyOptionals() {
        return false;
    }

    /**
     * Generated objects exclude fields with empty collection (list, set, and map) values.
     */
    @Value.Default
    default boolean excludeEmptyCollections() {
        return false;
    }

    /**
     * Instructs the object generator to generate union visitors that expose the values of unknowns in addition to their
     * types.
     */
    @Value.Default
    default boolean unionsWithUnknownValues() {
        return false;
    }

    /**
     * Instructs the {@link com.palantir.conjure.java.types.ErrorGenerator} to add {@code Contract} annotations
     * to check methods for stronger static analysis.
     */
    @Value.Default
    default boolean jetbrainsContractAnnotations() {
        return false;
    }

    /** When set, external type imports are generated as their fallback types. */
    @Value.Default
    default boolean externalFallbackTypes() {
        return false;
    }

    Optional packagePrefix();

    Optional apiVersion();

    class Builder extends ImmutableOptions.Builder {}

    static Builder builder() {
        return new Builder();
    }

    static Options empty() {
        return builder().build();
    }
}