/*
 * Copyright (c) 2007-2008, Dennis M. Sosnoski. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following
 * disclaimer. 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. Neither the name of
 * JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 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 THE COPYRIGHT OWNER OR 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.
 */

package org.jibx.schema.codegen;

import org.eclipse.jdt.core.dom.Block;
import org.eclipse.jdt.core.dom.MethodDeclaration;
import org.eclipse.jdt.core.dom.SingleVariableDeclaration;
import org.eclipse.jdt.core.dom.Type;

/**
 * Abstract syntax tree method declaration builder. This adds convenience methods and control information to the base
 * builder.
 */
public class MethodBuilder extends BodyBuilderBase
{
    /** Method invocation. */
    private final MethodDeclaration m_method;
    
    /**
     * Constructor.
     * 
     * @param source
     * @param method 
     */
    public MethodBuilder(ClassBuilder source, MethodDeclaration method) {
        super(source, method);
        m_method = method;
    }
    
    /**
     * Add a method parameter.
     * 
     * @param name
     * @param type 
     */
    public void addParameter(String name, Type type) {
        SingleVariableDeclaration vdecl = m_ast.newSingleVariableDeclaration();
        vdecl.setType(type);
        vdecl.setName(m_ast.newSimpleName(name));
        m_method.parameters().add(vdecl);
    }
    
    /**
     * Add a method parameter.
     * 
     * @param name
     * @param type fully-qualfied type name, or primitive name, with optional array suffixes
     */
    public void addParameter(String name, String type) {
        addParameter(name, m_source.createType(type));
    }
    
    /**
     * Add an exception type to those thrown by the method.
     *
     * @param type exception type
     */
    public void addThrows(String type) {
        m_method.thrownExceptions().add(m_source.createTypeName(type));
    }
    
    /**
     * Create a block builder for the method body.
     *
     * @return builder
     */
    public BlockBuilder createBlock() {
        Block block = m_ast.newBlock();
        m_method.setBody(block);
        return new BlockBuilder(m_source, block);
    }
}