org.jooq.JSONArrayAggNullStep Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation

There is a newer version: 3.19.16

/*
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jetbrains.annotations.*;


// ...
// ...
import static org.jooq.SQLDialect.H2;
// ...
import static org.jooq.SQLDialect.POSTGRES;
import static org.jooq.SQLDialect.SQLITE;
import static org.jooq.SQLDialect.YUGABYTEDB;

import org.jooq.impl.DSL;

/**
 * A step in the construction of {@link DSL#jsonArrayAgg(Field)} or
 * {@link DSL#jsonbArrayAgg(Field)} functions where the NULL clause
 * can be defined.
 *
 * @author Lukas Eder
 */
public interface JSONArrayAggNullStep extends JSONArrayAggReturningStep {

    /**
     * Include NULL values in output JSON.
     */
    @NotNull
    @Support({ H2, POSTGRES, SQLITE, YUGABYTEDB })
    JSONArrayAggReturningStep nullOnNull();

    /**
     * Exclude NULL values in output JSON.
     */
    @NotNull
    @Support({ H2, POSTGRES, SQLITE, YUGABYTEDB })
    JSONArrayAggReturningStep absentOnNull();
}