BodyDeclaration.java

/* 
  Copyright (C) 2013 Raquel Pau and Albert Coroleu.
 
 Walkmod is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 
 Walkmod is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Lesser General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public License
 along with Walkmod.  If not, see <http://www.gnu.org/licenses/>.*/
package org.walkmod.javalang.ast.body;

import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.walkmod.javalang.ast.Node;
import org.walkmod.javalang.ast.ScopeAware;
import org.walkmod.javalang.ast.SymbolDefinition;
import org.walkmod.javalang.ast.expr.AnnotationExpr;
import org.walkmod.merger.MergeEngine;

/**
 * @author Julio Vilmar Gesser
 */
public abstract class BodyDeclaration extends Node implements ScopeAware{

   private JavadocComment javaDoc;

   private List<AnnotationExpr> annotations;

   public BodyDeclaration() {
   }

   public BodyDeclaration(List<AnnotationExpr> annotations, JavadocComment javaDoc) {
      setJavaDoc(javaDoc);
      setAnnotations(annotations);
   }

   public BodyDeclaration(int beginLine, int beginColumn, int endLine, int endColumn, List<AnnotationExpr> annotations,
         JavadocComment javaDoc) {
      super(beginLine, beginColumn, endLine, endColumn);
      setJavaDoc(javaDoc);
      setAnnotations(annotations);
   }

   @Override
   public List<Node> getChildren() {
      List<Node> children = new LinkedList<Node>();
      if (javaDoc != null) {
         children.add(javaDoc);
      }
      if (annotations != null) {
         children.addAll(annotations);
      }
      return children;
   }

   @Override
   public boolean removeChild(Node child) {
      boolean result = false;
      if (child != null) {
         if (child instanceof AnnotationExpr) {
            if (annotations != null) {
               List<AnnotationExpr> aux = new LinkedList<AnnotationExpr>(annotations);
               result = aux.remove(child);
               this.annotations = aux;
            }
         } else if (child instanceof JavadocComment) {
            if (javaDoc != null && javaDoc.equals(child)) {
               javaDoc = null;
               result = true;
            }
         }
      }
      if(result){
         updateReferences(child);
      }
      return result;
   }

   public final JavadocComment getJavaDoc() {
      return javaDoc;
   }

   public final List<AnnotationExpr> getAnnotations() {
      return annotations;
   }

   public final void setJavaDoc(JavadocComment javaDoc) {
      this.javaDoc = javaDoc;
      setAsParentNodeOf(javaDoc);
   }

   public final void setAnnotations(List<AnnotationExpr> annotations) {
      this.annotations = annotations;
      setAsParentNodeOf(annotations);
   }

   public void merge(BodyDeclaration remoteBodyDeclaration, MergeEngine configuration) {
      List<AnnotationExpr> resultAnnotations = new LinkedList<AnnotationExpr>();
      configuration.apply(getAnnotations(), remoteBodyDeclaration.getAnnotations(), resultAnnotations,
            AnnotationExpr.class);
      setAnnotations(resultAnnotations);

      setJavaDoc((JavadocComment) (configuration.apply(getJavaDoc(), remoteBodyDeclaration.getJavaDoc(),
            JavadocComment.class)));
   }

   @Override
   public boolean replaceChildNode(Node oldChild, Node newChild) {
      if(newChild instanceof JavadocComment){
         setJavaDoc((JavadocComment) newChild);
         return true;
      }
      return replaceChildNodeInList(oldChild, newChild, annotations);
   }
   
   @Override
   public Map<String, SymbolDefinition> getVariableDefinitions(){
      Node parent = getParentNode();
      while (parent != null && parent instanceof ScopeAware) {
         parent = parent.getParentNode();
      }
      if (parent != null && (parent instanceof ScopeAware)) {
         return ((ScopeAware) parent).getVariableDefinitions();
      }
      return new HashMap<String, SymbolDefinition>();
   }
   
   @Override
   public Map<String, List<SymbolDefinition>> getMethodDefinitions(){
      Node parent = getParentNode();
      while (parent != null && parent instanceof ScopeAware) {
         parent = parent.getParentNode();
      }
      if (parent != null && (parent instanceof ScopeAware)) {
         return ((ScopeAware) parent).getMethodDefinitions();
      }
      return new HashMap<String, List<SymbolDefinition>>();
   }

   @Override
   public Map<String, SymbolDefinition> getTypeDefinitions() {
      Node parent = getParentNode();
      while (parent != null && parent instanceof ScopeAware) {
         parent = parent.getParentNode();
      }
      if (parent != null && (parent instanceof ScopeAware)) {
         return ((ScopeAware) parent).getTypeDefinitions();
      }
      return new HashMap<String, SymbolDefinition>();
   }
}