All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.stargate.db.datastore.query.Parameter Maven / Gradle / Ivy

There is a newer version: 2.1.0-BETA-19
Show newest version
/*
 * Copyright DataStax, Inc. and/or The Stargate Authors
 *
 * 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 io.stargate.db.datastore.query;

import io.stargate.db.schema.Column;
import java.util.Optional;
import java.util.function.Function;

public interface Parameter extends Comparable {
  Column column();

  /**
   * The value set to the parameter in the built query, if one is. If this return an empty optional,
   * it means the corresponding parameter is an unbound parameter (that must be bound at execution).
   */
  Optional value();

  Optional> bindingFunction();

  default int compareTo(Parameter other) {
    return column().name().compareTo(other.column().name());
  }

  default boolean ignored() {
    return false;
  }

  default Parameter ignore() {
    return this;
  }
}