SqlAdvisorHint2.java

/*
 * 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 org.apache.calcite.sql.advise;

import org.apache.calcite.sql.validate.SqlMoniker;

import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * This class is used to return values for
 * {@link SqlAdvisor#getCompletionHints (String, int, String[])}.
 */
public class SqlAdvisorHint2 extends SqlAdvisorHint {
  /** Replacement string. */
  public final @Nullable String replacement;

  public SqlAdvisorHint2(String id, String @Nullable [] names, String type,
      @Nullable String replacement) {
    super(id, names, type);
    this.replacement = replacement;
  }

  public SqlAdvisorHint2(SqlMoniker id, String replacement) {
    super(id);
    this.replacement = replacement;
  }
}