/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.quercus.program;

import com.caucho.quercus.env.MethodIntern;
import com.caucho.quercus.env.StringValue;
import com.caucho.quercus.expr.Expr;

/**
 * Represents a formal argument.
 */
public class Arg {
  private final StringValue _name;
  private final Expr _default;

  private final boolean _isReference;
  private final String _expectedClass;


  public Arg(String name,
             Expr defaultExpr,
             boolean isReference,
             String expectedClass)
  {
    _name = MethodIntern.intern(name);
    _default = defaultExpr;
    _isReference = isReference;
    _expectedClass = expectedClass;

    if (_default == null)
      throw new IllegalStateException();
  }

  /**
   * Returns the argument name.
   */
  public StringValue getName()
  {
    return _name;
  }

  /**
   * Returns the default expression
   */
  public Expr getDefault()
  {
    return _default;
  }

  /**
   * Returns true for a reference argument.
   */
  public boolean isReference()
  {
    return _isReference;
  }

  /**
   * Returns the expected classname
   */
  public String getExpectedClass()
  {
    return _expectedClass;
  }
  
  public String toString()
  {
    return "Arg[" + _name + "]";
  }
}