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.update;
  
  import com.datastax.oss.driver.api.core.CqlIdentifier;
  import com.datastax.oss.driver.api.core.cql.Statement;
  import com.datastax.oss.driver.api.querybuilder.BuildableQuery;
  import com.datastax.oss.driver.api.querybuilder.CqlSnippet;
  import com.datastax.oss.driver.api.querybuilder.QueryBuilder;
  import com.datastax.oss.driver.api.querybuilder.term.Term;
  import com.datastax.oss.driver.internal.querybuilder.lhs.ColumnComponentLeftOperand;
  import com.datastax.oss.driver.internal.querybuilder.lhs.ColumnLeftOperand;
  import com.datastax.oss.driver.internal.querybuilder.lhs.FieldLeftOperand;
  import com.datastax.oss.driver.internal.querybuilder.update.AppendAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.AppendListElementAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.AppendMapEntryAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.AppendSetElementAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.DecrementAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.DefaultAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.IncrementAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.PrependAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.PrependListElementAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.PrependMapEntryAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.PrependSetElementAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.RemoveAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.RemoveListElementAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.RemoveMapEntryAssignment;
  import com.datastax.oss.driver.internal.querybuilder.update.RemoveSetElementAssignment;
  import edu.umd.cs.findbugs.annotations.NonNull;
  
  /** An assignment that appears after the SET keyword in an UPDATE statement. */
  public interface Assignment extends CqlSnippet {
  
    /** Assigns a value to a column, as in {@code SET c=?}. */
    @NonNull
    static Assignment setColumn(@NonNull CqlIdentifier columnId, @NonNull Term value) {
      return new DefaultAssignment(new ColumnLeftOperand(columnId), "=", value);
    }
  
    /**
     * Shortcut for {@link #setColumn(CqlIdentifier, Term)
     * setColumn(CqlIdentifier.fromCql(columnName), value)}.
     */
    @NonNull
    static Assignment setColumn(@NonNull String columnName, @NonNull Term value) {
      return setColumn(CqlIdentifier.fromCql(columnName), value);
    }
  
    /** Assigns a value to a field of a UDT, as in {@code SET address.zip=?}. */
    @NonNull
    static Assignment setField(
        @NonNull CqlIdentifier columnId, @NonNull CqlIdentifier fieldId, @NonNull Term value) {
      return new DefaultAssignment(new FieldLeftOperand(columnId, fieldId), "=", value);
    }
  
    /**
     * Shortcut for {@link #setField(CqlIdentifier, CqlIdentifier, Term)
     * setField(CqlIdentifier.fromCql(columnName), CqlIdentifier.fromCql(fieldName), value)}.
     */
    @NonNull
    static Assignment setField(
        @NonNull String columnName, @NonNull String fieldName, @NonNull Term value) {
      return setField(CqlIdentifier.fromCql(columnName), CqlIdentifier.fromCql(fieldName), value);
    }
  
    /** Assigns a value to an entry in a map column, as in {@code SET map[?]=?}. */
    @NonNull
    static Assignment setMapValue(
        @NonNull CqlIdentifier columnId, @NonNull Term key, @NonNull Term value) {
      return new DefaultAssignment(new ColumnComponentLeftOperand(columnId, key), "=", value);
    }
  
    /**
     * Shortcut for {@link #setMapValue(CqlIdentifier, Term, Term)
     * setMapValue(CqlIdentifier.fromCql(columnName), index, value)}.
     */
    @NonNull
    static Assignment setMapValue(
        @NonNull String columnName, @NonNull Term key, @NonNull Term value) {
      return setMapValue(CqlIdentifier.fromCql(columnName), key, value);
    }
  
    /** Assigns a value to an index in a list column, as in {@code SET list[?]=?}. */
    @NonNull
    static Assignment setListValue(
        @NonNull CqlIdentifier columnId, @NonNull Term index, @NonNull Term value) {
      return new DefaultAssignment(new ColumnComponentLeftOperand(columnId, index), "=", value);
    }
  
    /**
     * Shortcut for {@link #setListValue(CqlIdentifier, Term, Term)
     * setMapValue(CqlIdentifier.fromCql(columnName), index, value)}.
     */
    @NonNull
    static Assignment setListValue(
        @NonNull String columnName, @NonNull Term index, @NonNull Term value) {
      return setListValue(CqlIdentifier.fromCql(columnName), index, value);
    }
  
    /** Increments a counter, as in {@code SET c=c+?}. */
    @NonNull
    static Assignment increment(@NonNull CqlIdentifier columnId, @NonNull Term amount) {
      return new IncrementAssignment(columnId, amount);
    }
  
    /**
     * Shortcut for {@link #increment(CqlIdentifier, Term)
     * increment(CqlIdentifier.fromCql(columnName), amount)}
     */
    @NonNull
    static Assignment increment(@NonNull String columnName, @NonNull Term amount) {
      return increment(CqlIdentifier.fromCql(columnName), amount);
    }
  
    /** Increments a counter by 1, as in {@code SET c=c+1} . */
    @NonNull
    static Assignment increment(@NonNull CqlIdentifier columnId) {
      return increment(columnId, QueryBuilder.literal(1));
    }
  
    /** Shortcut for {@link #increment(CqlIdentifier) CqlIdentifier.fromCql(columnName)}. */
    @NonNull
    static Assignment increment(@NonNull String columnName) {
      return increment(CqlIdentifier.fromCql(columnName));
    }
  
    /** Decrements a counter, as in {@code SET c=c-?}. */
    @NonNull
    static Assignment decrement(@NonNull CqlIdentifier columnId, @NonNull Term amount) {
      return new DecrementAssignment(columnId, amount);
    }
  
    /**
     * Shortcut for {@link #decrement(CqlIdentifier, Term)
     * decrement(CqlIdentifier.fromCql(columnName), amount)}
     */
    @NonNull
    static Assignment decrement(@NonNull String columnName, @NonNull Term amount) {
      return decrement(CqlIdentifier.fromCql(columnName), amount);
    }
  
    /** Decrements a counter by 1, as in {@code SET c=c-1} . */
    @NonNull
    static Assignment decrement(@NonNull CqlIdentifier columnId) {
      return decrement(columnId, QueryBuilder.literal(1));
    }
  
    /** Shortcut for {@link #decrement(CqlIdentifier) CqlIdentifier.fromCql(columnName)}. */
    @NonNull
    static Assignment decrement(@NonNull String columnName) {
      return decrement(CqlIdentifier.fromCql(columnName));
    }
  
    /**
     * Appends to a collection column, as in {@code SET l=l+?}.
     *
     * <p>The term must be a collection of the same type as the column.
     */
    @NonNull
    static Assignment append(@NonNull CqlIdentifier columnId, @NonNull Term suffix) {
      return new AppendAssignment(columnId, suffix);
    }
  
    /**
     * Shortcut for {@link #append(CqlIdentifier, Term) append(CqlIdentifier.fromCql(columnName),
     * suffix)}.
     */
    @NonNull
    static Assignment append(@NonNull String columnName, @NonNull Term suffix) {
      return append(CqlIdentifier.fromCql(columnName), suffix);
    }
  
    /**
     * Appends a single element to a list column, as in {@code SET l=l+[?]}.
     *
     * <p>The term must be of the same type as the column's elements.
     */
    @NonNull
    static Assignment appendListElement(@NonNull CqlIdentifier columnId, @NonNull Term suffix) {
      return new AppendListElementAssignment(columnId, suffix);
    }
  
    /**
     * Shortcut for {@link #appendListElement(CqlIdentifier, Term)
     * appendListElement(CqlIdentifier.fromCql(columnName), suffix)}.
     */
    @NonNull
    static Assignment appendListElement(@NonNull String columnName, @NonNull Term suffix) {
      return appendListElement(CqlIdentifier.fromCql(columnName), suffix);
    }
  
    /**
     * Appends a single element to a set column, as in {@code SET s=s+{?}}.
     *
     * <p>The term must be of the same type as the column's elements.
     */
    @NonNull
    static Assignment appendSetElement(@NonNull CqlIdentifier columnId, @NonNull Term suffix) {
      return new AppendSetElementAssignment(columnId, suffix);
    }
  
    /**
     * Shortcut for {@link #appendSetElement(CqlIdentifier, Term)
     * appendSetElement(CqlIdentifier.fromCql(columnName), suffix)}.
     */
    @NonNull
    static Assignment appendSetElement(@NonNull String columnName, @NonNull Term suffix) {
      return appendSetElement(CqlIdentifier.fromCql(columnName), suffix);
    }
  
    /**
     * Appends a single entry to a map column, as in {@code SET m=m+{?:?}}.
     *
     * <p>The terms must be of the same type as the column's keys and values respectively.
     */
    @NonNull
    static Assignment appendMapEntry(
        @NonNull CqlIdentifier columnId, @NonNull Term key, @NonNull Term value) {
      return new AppendMapEntryAssignment(columnId, key, value);
    }
  
    /**
     * Shortcut for {@link #appendMapEntry(CqlIdentifier, Term, Term)
     * appendMapEntry(CqlIdentifier.fromCql(columnName), key, value)}.
     */
    @NonNull
    static Assignment appendMapEntry(
        @NonNull String columnName, @NonNull Term key, @NonNull Term value) {
      return appendMapEntry(CqlIdentifier.fromCql(columnName), key, value);
    }
  
    /**
     * Prepends to a collection column, as in {@code SET l=[1,2,3]+l}.
     *
     * <p>The term must be a collection of the same type as the column.
     */
    @NonNull
    static Assignment prepend(@NonNull CqlIdentifier columnId, @NonNull Term prefix) {
      return new PrependAssignment(columnId, prefix);
    }
  
    /**
     * Shortcut for {@link #prepend(CqlIdentifier, Term) prepend(CqlIdentifier.fromCql(columnName),
     * prefix)}.
     */
    @NonNull
    static Assignment prepend(@NonNull String columnName, @NonNull Term prefix) {
      return prepend(CqlIdentifier.fromCql(columnName), prefix);
    }
  
    /**
     * Prepends a single element to a list column, as in {@code SET l=[?]+l}.
     *
     * <p>The term must be of the same type as the column's elements.
     */
    @NonNull
    static Assignment prependListElement(@NonNull CqlIdentifier columnId, @NonNull Term suffix) {
      return new PrependListElementAssignment(columnId, suffix);
    }
  
    /**
     * Shortcut for {@link #prependListElement(CqlIdentifier, Term)
     * prependListElement(CqlIdentifier.fromCql(columnName), suffix)}.
     */
    @NonNull
    static Assignment prependListElement(@NonNull String columnName, @NonNull Term suffix) {
      return prependListElement(CqlIdentifier.fromCql(columnName), suffix);
    }
  
    /**
     * Prepends a single element to a set column, as in {@code SET s={?}+s}.
     *
     * <p>The term must be of the same type as the column's elements.
     */
    @NonNull
    static Assignment prependSetElement(@NonNull CqlIdentifier columnId, @NonNull Term suffix) {
      return new PrependSetElementAssignment(columnId, suffix);
    }
  
    /**
     * Shortcut for {@link #prependSetElement(CqlIdentifier, Term)
     * prependSetElement(CqlIdentifier.fromCql(columnName), suffix)}.
     */
    @NonNull
    static Assignment prependSetElement(@NonNull String columnName, @NonNull Term suffix) {
      return prependSetElement(CqlIdentifier.fromCql(columnName), suffix);
    }
  
    /**
     * Prepends a single entry to a map column, as in {@code SET m={?:?}+m}.
     *
     * <p>The terms must be of the same type as the column's keys and values respectively.
     */
    @NonNull
    static Assignment prependMapEntry(
        @NonNull CqlIdentifier columnId, @NonNull Term key, @NonNull Term value) {
      return new PrependMapEntryAssignment(columnId, key, value);
    }
  
    /**
     * Shortcut for {@link #prependMapEntry(CqlIdentifier, Term, Term)
     * prependMapEntry(CqlIdentifier.fromCql(columnName), key, value)}.
     */
    @NonNull
    static Assignment prependMapEntry(
        @NonNull String columnName, @NonNull Term key, @NonNull Term value) {
      return prependMapEntry(CqlIdentifier.fromCql(columnName), key, value);
    }
  
    /**
     * Removes elements from a collection, as in {@code SET l=l-[1,2,3]}.
     *
     * <p>The term must be a collection of the same type as the column.
     *
     * <p><b>DO NOT USE THIS TO DECREMENT COUNTERS.</b> Use the dedicated {@link
     * #decrement(CqlIdentifier, Term)} methods instead. While the operator is technically the same,
     * and it would be possible to generate an expression such as {@code counter-=1} with this method,
     * a collection removal is idempotent while a counter decrement isn't.
     */
    @NonNull
    static Assignment remove(@NonNull CqlIdentifier columnId, @NonNull Term collectionToRemove) {
      return new RemoveAssignment(columnId, collectionToRemove);
    }
  
    /**
     * Shortcut for {@link #remove(CqlIdentifier, Term) remove(CqlIdentifier.fromCql(columnName),
     * collectionToRemove)}.
     */
    @NonNull
    static Assignment remove(@NonNull String columnName, @NonNull Term collectionToRemove) {
      return remove(CqlIdentifier.fromCql(columnName), collectionToRemove);
    }
  
    /**
     * Removes a single element from a list column, as in {@code SET l=l-[?]}.
     *
     * <p>The term must be of the same type as the column's elements.
     */
    @NonNull
    static Assignment removeListElement(@NonNull CqlIdentifier columnId, @NonNull Term suffix) {
      return new RemoveListElementAssignment(columnId, suffix);
    }
  
    /**
     * Shortcut for {@link #removeListElement(CqlIdentifier, Term)
     * removeListElement(CqlIdentifier.fromCql(columnName), suffix)}.
     */
    @NonNull
    static Assignment removeListElement(@NonNull String columnName, @NonNull Term suffix) {
      return removeListElement(CqlIdentifier.fromCql(columnName), suffix);
    }
  
    /**
     * Removes a single element from a set column, as in {@code SET s=s-{?}}.
     *
     * <p>The term must be of the same type as the column's elements.
     */
    @NonNull
    static Assignment removeSetElement(@NonNull CqlIdentifier columnId, @NonNull Term suffix) {
      return new RemoveSetElementAssignment(columnId, suffix);
    }
  
    /**
     * Shortcut for {@link #removeSetElement(CqlIdentifier, Term)
     * removeSetElement(CqlIdentifier.fromCql(columnName), suffix)}.
     */
    @NonNull
    static Assignment removeSetElement(@NonNull String columnName, @NonNull Term suffix) {
      return removeSetElement(CqlIdentifier.fromCql(columnName), suffix);
    }
  
    /**
     * Removes a single entry from a map column, as in {@code SET m=m-{?:?}}.
     *
     * <p>The terms must be of the same type as the column's keys and values respectively.
     */
    @NonNull
    static Assignment removeMapEntry(
        @NonNull CqlIdentifier columnId, @NonNull Term key, @NonNull Term value) {
      return new RemoveMapEntryAssignment(columnId, key, value);
    }
  
    /**
     * Shortcut for {@link #removeMapEntry(CqlIdentifier, Term, Term)
     * removeMapEntry(CqlIdentifier.fromCql(columnName), key, value)}.
     */
    @NonNull
    static Assignment removeMapEntry(
        @NonNull String columnName, @NonNull Term key, @NonNull Term value) {
      return removeMapEntry(CqlIdentifier.fromCql(columnName), key, value);
    }
  
    /**
     * Whether this assignment is idempotent.
     *
     * <p>That is, whether it always sets its target column to the same value when used multiple
     * times. For example, {@code UPDATE ... SET c=1} is idempotent, {@code SET l=l+[1]} isn't.
     *
     * <p>This is used internally by the query builder to compute the {@link Statement#isIdempotent()}
     * flag on the UPDATE statements generated by {@link BuildableQuery#build()}. If an assignment is
     * ambiguous (for example a raw snippet or a call to a user function in the right operands), the
     * builder is pessimistic and assumes the term is not idempotent.
     */
    boolean isIdempotent();
  }
  