UseCboRuleHint.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.doris.nereids.hint;

/**
 * rule hint.
 */
public class UseCboRuleHint extends Hint {

    private final boolean isNotUseCboRule;

    public UseCboRuleHint(String hintName, boolean isNotUseCboRule) {
        super(hintName);
        this.isNotUseCboRule = isNotUseCboRule;
    }

    public boolean isNotUseCboRule() {
        return isNotUseCboRule;
    }

    @Override
    public String getExplainString() {
        StringBuilder out = new StringBuilder();
        if (isNotUseCboRule) {
            out.append("no_use_");
        } else {
            out.append("use_");
        }
        out.append(getHintName());
        return out.toString();
    }
}