LocalVar.java

/*
 * Copyright 2013 Google Inc.
 *
 * 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.google.template.soy.soytree.defn;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.template.soy.soytree.SoyNode.LocalVarNode;
import com.google.template.soy.types.SoyType;

/**
 * A local variable declaration.
 *
 */
public class LocalVar extends AbstractVarDefn {

  private final LocalVarNode declaringNode;

  /**
   * @param name The variable name.
   * @param declaringNode The statement in which this variable is defined.
   * @param type The data type of the variable.
   */
  public LocalVar(String name, LocalVarNode declaringNode, SoyType type) {
    super(name, type);
    this.declaringNode = declaringNode;
  }

  /** Copy constructor for when the declaring node is being cloned. */
  public LocalVar(LocalVar localVar, LocalVarNode declaringNode) {
    super(localVar);
    checkArgument(localVar.declaringNode != declaringNode);
    this.declaringNode = declaringNode;
  }

  @Override
  public Kind kind() {
    return Kind.LOCAL_VAR;
  }

  /**
   * Setter for the type - this is necessary because sometimes we don't know the variable type until
   * after analysis.
   *
   * @param type The data type of the variable.
   */
  public void setType(SoyType type) {
    this.type = type;
  }

  public LocalVarNode declaringNode() {
    return declaringNode;
  }

  @Override
  public boolean isInjected() {
    return false;
  }
}