/*
 * 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
 *
 *  https://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: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jetbrains.annotations.*;
import org.jetbrains.annotations.ApiStatus.Experimental;

import java.util.Collection;

import org.jooq.impl.DSL;
import org.jooq.impl.QOM;
import org.jooq.impl.QOM.UnmodifiableList;

/**
 * An unqualified asterisk.
 * <p>
 * Asterisks (qualified and unqualified) are expressions that can be used
 * exclusively in <code>SELECT</code> clauses and a few other clauses that
 * explicitly allow for asterisks, including <code>RETURNING</code> on DML
 * statements. Asterisks are syntax sugar in SQL, which are expanded to a column
 * list by the parser once all the columns in the <code>FROM</code> clause are
 * known.
 * <p>
 * <strong>Example:</strong>
 * <p>
 * <pre><code>
 * // Assuming import static org.jooq.impl.DSL.*;
 *
 * using(configuration)
 *    .select(asterisk())
 *    .from(ACTOR)
 *    .fetch();
 * </code></pre>
 * <p>
 * Instances can be created using {@link DSL#asterisk()}.
 *
 * @see Table#asterisk()
 * @author Lukas Eder
 */
public interface Asterisk extends SelectFieldOrAsterisk {

    /**
     * The asterisk (<code>* EXCEPT (fields)</code>) expression to be used in
     * <code>SELECT</code> clauses.
     * <p>
     * This expression is a convenient way to select "all but some fields". Some
     * dialects (e.g. {@link SQLDialect#H2}) implement this feature natively. In
     * other dialects, jOOQ expands the asterisk if possible.
     */
    @NotNull
    @Support
    Asterisk except(String... fieldNames);

    /**
     * The asterisk (<code>*</code>) to be used in <code>SELECT</code> clauses.
     * <p>
     * This expression is a convenient way to select "all but some fields". Some
     * dialects (e.g. {@link SQLDialect#H2}) implement this feature natively. In
     * other dialects, jOOQ expands the asterisk if possible.
     */
    @NotNull
    @Support
    Asterisk except(Name... fieldNames);

    /**
     * The asterisk (<code>*</code>) to be used in <code>SELECT</code> clauses.
     * <p>
     * This expression is a convenient way to select "all but some fields". Some
     * dialects (e.g. {@link SQLDialect#H2}) implement this feature natively. In
     * other dialects, jOOQ expands the asterisk if possible.
     */
    @NotNull
    @Support
    Asterisk except(Field<?>... fields);

    /**
     * The asterisk (<code>*</code>) to be used in <code>SELECT</code> clauses.
     * <p>
     * This expression is a convenient way to select "all but some fields". Some
     * dialects (e.g. {@link SQLDialect#H2}) implement this feature natively. In
     * other dialects, jOOQ expands the asterisk if possible.
     */
    @NotNull
    @Support
    Asterisk except(Collection<? extends Field<?>> fields);

    // -------------------------------------------------------------------------
    // XXX: Query Object Model
    // -------------------------------------------------------------------------

    /**
     * Experimental query object model accessor method, see also {@link QOM}.
     * Subject to change in future jOOQ versions, use at your own risk.
     */
    @Experimental
    @NotNull UnmodifiableList<? extends Field<?>> $except();
}
