java/java-psi-impl/src/com/intellij/psi/controlFlow/ControlFlow.java

/*
 * Copyright 2000-2012 JetBrains s.r.o.
 *
 * 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 com.intellij.psi.controlFlow;

import com.intellij.psi.PsiElement;
import org.jetbrains.annotations.NotNull;

import java.util.List;

/**
 * @author cdr
 */
public interface ControlFlow {
  ControlFlow EMPTY = new ControlFlowImpl();

  @NotNull
  List<Instruction> getInstructions();

  int getSize();

  int getStartOffset(@NotNull PsiElement element);

  int getEndOffset(@NotNull PsiElement element);

  PsiElement getElement(int offset);

  // true means there is at least one place where control flow has been short-circuited due to constant condition
  // false means no constant conditions were detected affecting control flow
  boolean isConstantConditionOccurred();
}