/**
    * Redistribution and use of this software and associated documentation ("Software"), with or
    * without modification, are permitted provided that the following conditions are met:
    *
    * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
    * must also contain a copy of this document.
    *
    * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
    * conditions and the following disclaimer in the documentation and/or other materials provided with
   * the distribution.
   *
   * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
   * without prior written permission of Intalio, Inc. For written permission, please contact
   * info@exolab.org.
   *
   * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
   * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
   * Intalio, Inc.
   *
   * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
   *
   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
   * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   *
   * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
   */
  package org.exolab.javasource;
  
  import java.util.LinkedHashMap;
  import java.util.Map;
  import java.util.Vector;
  
  /**
   * A class for handling source code for a constructor of a JClass.
   *
   * @author <a href="mailto:keith AT kvisco DOT com">Keith Visco</a>
   * @version $Revision$ $Date: 2005-05-08 05:24:54 -0600 (Sun, 08 May 2005) $
   */
  public final class JConstructor extends JAnnotatedElementHelper {
  
    /** The set of modifiers for this JConstructor. */
    private JModifiers _modifiers = new JModifiers();
  
    /** List of parameters for this JConstructor. */
    private final Map<String, JParameter> _params = new LinkedHashMap<String, JParameter>();
  
    /** The Class in this JConstructor has been declared. */
    private final AbstractJClass _declaringClass;
  
    /** The source code for this constructor. */
    private JSourceCode _sourceCode = new JSourceCode();
  
    /** The exceptions that this JConstructor throws. */
    private final Vector<JClass> _exceptions = new Vector<>(1);
  
    /**
     * Creates a new JConstructor for the provided declaring class.
     * 
     * @param declaringClass The class this constructor creates.
     */
    protected JConstructor(final AbstractJClass declaringClass) {
      _declaringClass = declaringClass;
    }
  
    /**
     * Returns the exceptions that this JConstructor lists in its throws clause.
     *
     * @return The exceptions that this JConstructor lists in its throws clause.
     */
    public JClass[] getExceptions() {
      return _exceptions.toArray(new JClass[_exceptions.size()]);
    }
  
    /**
     * Adds the given Exception to this JConstructor's throws clause.
     *
     * @param exp The JClass representing the Exception.
     */
    public void addException(final JClass exp) {
      if (exp == null) {
        return;
      }
  
      // -- make sure exception is not already added
      String expClassName = exp.getName();
      for (JClass jClass : _exceptions) {
        if (expClassName.equals(jClass.getName())) {
          return;
        }
      }
      // -- add exception
      _exceptions.add(exp);
    }
 
   /**
    * Returns an array of JParameters consisting of the parameters of this JConstructor in declared
    * order.
    *
    * @return A JParameter array consisting of the parameters of this JConstructor in declared order.
    */
   public JParameter[] getParameters() {
     return _params.values().toArray(new JParameter[_params.size()]);
   }
 
   /**
    * Returns the amount of parameters.
    * 
    * @return The amount of parameters.
    */
   public int getParameterCount() {
     return _params.size();
   }
 
   /**
    * Adds the given parameter to this JConstructor's list of parameters.
    *
    * @param parameter The parameter to add to the this JConstructor's list of parameters.
    */
   public void addParameter(final JParameter parameter) {
     if (parameter == null) {
       return;
     }
 
     // -- check current params
     if (_params.get(parameter.getName()) != null) {
       String err = new StringBuilder(64).append("A parameter already exists for the constructor, ")
           .append(this._declaringClass.getName()).append(", with the name: ")
           .append(parameter.getName()).toString();
       throw new IllegalArgumentException(err);
     }
 
     _params.put(parameter.getName(), parameter);
 
     // -- be considerate and add the class name to the
     // -- declaring class's list of imports
     if (_declaringClass != null) {
       JType jType = parameter.getType();
       if (!jType.isPrimitive()) {
         _declaringClass.addImport(jType.getName());
       }
     }
   }
 
   /**
    * Returns the class in which this JConstructor has been declared.
    *
    * @return The class in which this JConstructor has been declared.
    */
   public AbstractJClass getDeclaringClass() {
     return _declaringClass;
   }
 
   /**
    * Returns the modifiers for this JConstructor.
    *
    * @return The modifiers for this JConstructor.
    */
   public JModifiers getModifiers() {
     return _modifiers;
   }
 
   /**
    * Sets the modifiers on this JConstructor.
    *
    * @param modifiers Modifiers to set on this constructor.
    */
   public void setModifiers(final JModifiers modifiers) {
     _modifiers = modifiers.copy();
     _modifiers.setFinal(false);
   }
 
   /**
    * Returns the source code for this JConstructor.
    * 
    * @return The source code.
    */
   public JSourceCode getSourceCode() {
     return _sourceCode;
   }
 
   /**
    * Sets the source code for this constructor.
    *
    * @param sourceCode Source code to apply to this constructor.
    */
   public void setSourceCode(final String sourceCode) {
     setSourceCode(new JSourceCode(sourceCode));
   }
 
   /**
    * Sets the source code for this constructor.
    *
    * @param sourceCode Source code to apply to this constructor.
    */
   public void setSourceCode(final JSourceCode sourceCode) {
     _sourceCode = sourceCode;
   }
 
   /**
    * Prints this JConstructor to the provided JSourceWriter.
    * 
    * @param jsw The JSourceWriter to print the constructor to.
    */
   public void print(final JSourceWriter jsw) {
     // -- print annotations
     printAnnotations(jsw);
 
     if (_modifiers.isPrivate()) {
       jsw.write("private");
     } else if (_modifiers.isProtected()) {
       jsw.write("protected");
     } else {
       jsw.write("public");
     }
     jsw.write(' ');
     jsw.write(_declaringClass.getLocalName());
     jsw.write('(');
 
     // -- any parameter annotations?
     boolean parameterAnnotations = false;
     for (JParameter jParameter : _params.values()) {
       if (jParameter.hasAnnotations()) {
         parameterAnnotations = true;
         break;
       }
     }
 
     // -- print parameters
     if (parameterAnnotations) {
       jsw.indent();
     }
     int parameterCount = 0;
     for (JParameter jParameter : _params.values()) {
       if (parameterCount > 0) {
         jsw.write(", ");
       }
       if (parameterAnnotations) {
         jsw.writeln();
       }
       jParameter.printAnnotations(jsw);
       String typeAndName = jParameter.toString();
       jsw.write(typeAndName);
       parameterCount++;
     }
     if (parameterAnnotations) {
       jsw.unindent();
     }
 
     jsw.write(")");
     if (!_exceptions.isEmpty()) {
       jsw.writeln();
       jsw.write("throws ");
       for (int i = 0; i < _exceptions.size(); i++) {
         if (i > 0) {
           jsw.write(", ");
         }
         JClass jClass = _exceptions.elementAt(i);
         jsw.write(jClass.getName());
       }
     }
     jsw.writeln(" {");
 
     _sourceCode.print(jsw);
 
     if (!jsw.isNewline()) {
       jsw.writeln();
     }
     jsw.writeln("}");
   }
 
   /**
    * {@inheritDoc}
    */
   public String toString() {
     StringBuilder sb = new StringBuilder(32).append(_declaringClass.getName()).append('(');
 
     // -- print parameters
     for (int i = 0; i < _params.size(); i++) {
       JParameter jp = _params.get(i);
       if (i > 0) {
         sb.append(", ");
       }
       sb.append(jp.getType().getName());
     }
     sb.append(')');
     return sb.toString();
   }
 
 }