PsiArrayAccessExpression.java

/*
 * Copyright 2000-2009 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;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * Represents an array access expession, for example, <code>i [1]</code>.
 */
public interface PsiArrayAccessExpression extends PsiExpression {
  /**
   * Returns the expression specifying the accessed array.
   *
   * @return the array expression.
   */
  @NotNull
  PsiExpression getArrayExpression();

  /**
   * Returns the index expression (the expression in square brackets).
   *
   * @return the index expression, or null if the array access expression is incomplete.
   */
  @Nullable
  PsiExpression getIndexExpression();
}