AbstractSoyNode.java

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


import com.google.template.soy.base.SourceLocation;
import com.google.template.soy.basetree.AbstractNode;
import com.google.template.soy.basetree.CopyState;

/**
 * Abstract implementation of a SoyNode.
 *
 * <p>Important: Do not use outside of Soy code (treat as superpackage-private).
 *
 */
public abstract class AbstractSoyNode extends AbstractNode implements SoyNode {

  /** The id for this node. */
  private int id;

  /** The location in the file from which this node was parsed or derived. */
  private final SourceLocation srcLoc;

  /**
   * @param id The id for this node.
   * @param sourceLocation The node's source location. {@code null} is allowed for a few special
   *     cases (SoyFileNode and SoyFileSetNode).
   */
  protected AbstractSoyNode(int id, SourceLocation sourceLocation) {
    this.id = id;
    srcLoc = sourceLocation;
  }

  /**
   * Copy constructor.
   *
   * @param orig The node to copy.
   */
  protected AbstractSoyNode(AbstractSoyNode orig, CopyState copyState) {
    super(orig, copyState);
    this.id = orig.id;
    this.srcLoc = orig.srcLoc;
  }

  @Override
  public void setId(int id) {
    this.id = id;
  }

  @Override
  public int getId() {
    return id;
  }

  /**
   * The location in the file from which this node was parsed or derived.
   *
   * <p>This is an optional operation. Some nodes don't have source locations.
   */
  @Override
  public SourceLocation getSourceLocation() {
    if (srcLoc == null) {
      throw new UnsupportedOperationException();
    }
    return srcLoc;
  }

  @Override
  public ParentSoyNode<?> getParent() {
    return (ParentSoyNode<?>) super.getParent();
  }

  @Override
  public String toString() {
    return super.toString() + "_" + id;
  }
}