001/*
002 * Copyright (c) 2016-2017 Chris K Wensel <chris@wensel.net>. All Rights Reserved.
003 * Copyright (c) 2007-2017 Xplenty, Inc. All Rights Reserved.
004 *
005 * Project and contact information: http://www.cascading.org/
006 *
007 * This file is part of the Cascading project.
008 *
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *     http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 */
021
022package cascading.operation;
023
024/**
025 * Interface PlannerLevel is the base interface for {@link DebugLevel} and {@link AssertionLevel} enum types.
026 * <p>
027 * It should be noted that all enum implementations of this interface must declare a NONE or equivalent instance. This
028 * special case type tells the  {@link cascading.flow.planner.FlowPlanner} to remove all {@link PlannedOperation} instances from
029 * the final {@link cascading.flow.Flow}.
030 *
031 * @see DebugLevel
032 * @see AssertionLevel
033 */
034public interface PlannerLevel
035  {
036  /**
037   * Returns true if this enum instance represents a value that instructs the {@link cascading.flow.planner.FlowPlanner} to
038   * remove all instances from the plan.
039   *
040   * @return true if this represents "NONE"
041   */
042  boolean isNoneLevel();
043
044  /**
045   * Returns true if the given {@link PlannerLevel} is less strict than this instance.
046   *
047   * @param plannerLevel of type PlannerLevel
048   * @return true if argument is less strict
049   */
050  boolean isStricterThan( PlannerLevel plannerLevel );
051  }