content: /*
   * Licensed to the Apache Software Foundation (ASF) under one
   * or more contributor license agreements.  See the NOTICE file
   * distributed with this work for additional information
   * regarding copyright ownership.  The ASF licenses this file
   * to you 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.datastax.oss.driver.api.querybuilder.relation;
  
  import com.datastax.oss.driver.api.querybuilder.BindMarker;
  import com.datastax.oss.driver.api.querybuilder.QueryBuilder;
  import com.datastax.oss.driver.api.querybuilder.term.Term;
  import edu.umd.cs.findbugs.annotations.NonNull;
  import edu.umd.cs.findbugs.annotations.Nullable;
  import java.util.Arrays;
  
  public interface InRelationBuilder<ResultT> {
  
    /**
     * Builds an IN relation where the whole set of possible values is a bound variable, as in {@code
     * IN ?}.
     */
    @NonNull
    default ResultT in(@NonNull BindMarker bindMarker) {
      return build(" IN ", bindMarker);
    }
  
    /**
     * Builds an IN relation where the arguments are the possible values, as in {@code IN (term1,
     * term2...)}.
     */
    @NonNull
    default ResultT in(@NonNull Iterable<Term> alternatives) {
      return build(" IN ", QueryBuilder.tuple(alternatives));
    }
  
    /** Var-arg equivalent of {@link #in(Iterable)} . */
    @NonNull
    default ResultT in(@NonNull Term... alternatives) {
      return in(Arrays.asList(alternatives));
    }
  
    /**
     * Builds a NOT IN relation where the whole set of possible values is a bound variable, as in
     * {@code NOT IN ?}.
     *
     * <p>Note that NOT IN support is only available in Cassandra 5.1 or later. See <a
     * href="https://issues.apache.org/jira/browse/CASSANDRA-18584">CASSANDRA-18584</a> for more
     * information.
     */
    @NonNull
    default ResultT notIn(@NonNull BindMarker bindMarker) {
      return build(" NOT IN ", bindMarker);
    }
  
    /**
     * Builds an IN relation where the arguments are the possible values, as in {@code IN (term1,
     * term2...)}.
     *
     * <p>Note that NOT IN support is only available in Cassandra 5.1 or later. See <a
     * href="https://issues.apache.org/jira/browse/CASSANDRA-18584">CASSANDRA-18584</a> for more
     * information.
     */
    @NonNull
    default ResultT notIn(@NonNull Iterable<Term> alternatives) {
      return build(" NOT IN ", QueryBuilder.tuple(alternatives));
    }
  
    /** Var-arg equivalent of {@link #notIn(Iterable)} . */
    @NonNull
    default ResultT notIn(@NonNull Term... alternatives) {
      return notIn(Arrays.asList(alternatives));
    }
  
    @NonNull
    ResultT build(@NonNull String operator, @Nullable Term rightOperand);
  }
  