java/java-impl/src/com/intellij/codeInsight/generation/GenerationInfo.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.codeInsight.generation;
  17
  18 import com.intellij.psi.*;
  19 import com.intellij.util.IncorrectOperationException;
  20 import org.jetbrains.annotations.NotNull;
  21 import org.jetbrains.annotations.Nullable;
  22
  23 /**
  24  * @author peter
  25  */
  26 public abstract class GenerationInfo {
  27   public static final GenerationInfo[] EMPTY_ARRAY = new GenerationInfo[0];
  28
  29   public abstract void insert(PsiClass aClass, PsiElement anchor, boolean before) throws IncorrectOperationException;
  30
  31   public abstract PsiMember getPsiMember();
  32
  33   /**
  34    * @param aClass
  35    * @param leaf leaf element. Is guaranteed to be a tree descendant of aClass.
  36    * @return the value that will be passed to the {@link #insert(com.intellij.psi.PsiClass, com.intellij.psi.PsiElement, boolean)} method later.
  37    */
  38   @Nullable
  39   public PsiElement findInsertionAnchor(@NotNull PsiClass aClass, @NotNull PsiElement leaf) {
  40     PsiElement element = leaf;
  41     while (element.getParent() != aClass) {
  42       element = element.getParent();
  43     }
  44
  45     PsiJavaToken lBrace = aClass.getLBrace();
  46     if (lBrace == null) {
  47       return null;
  48     }
  49     PsiJavaToken rBrace = aClass.getRBrace();
  50     if (!GenerateMembersUtil.isChildInRange(element, lBrace.getNextSibling(), rBrace)) {
  51       return null;
  52     }
  53     PsiElement prev = leaf.getPrevSibling();
  54     if (prev != null && prev.getNode() != null && prev.getNode().getElementType() == JavaTokenType.END_OF_LINE_COMMENT) {
  55       element = leaf.getNextSibling();
  56     }
  57     return element;
  58   }
  59 }