org.apache.hadoop.hive.ql.plan.Explain Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hive-exec Show documentation

The newest version!

/**
 * 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.hadoop.hive.ql.plan;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Explain.
 *
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface Explain {
  public enum Level {
    USER, DEFAULT, EXTENDED;
    public boolean in(Level[] levels) {
      for (Level level : levels) {
        if (level.equals(this)) {
          return true;
        }
      }
      return false;
    }
  };
  String displayName() default "";

  Level[] explainLevels() default { Level.DEFAULT, Level.EXTENDED };

  boolean displayOnlyOnTrue() default false;

  boolean skipHeader() default false;
}