/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 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 end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:  
 *       "This product includes software developed by the 
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Ant", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written 
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``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 THE APACHE SOFTWARE FOUNDATION 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.tools.ant.taskdefs;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.types.Commandline;

/**
 * An <code>AssertionArgument</code> represents a command line argument to
 * the <code>java</code> command for enabling and disabling runtime assertions.
 *
 * An <code>AssertionArgument</code> is instantiated for each
 * &lt;enableassertions&gt; and &lt;disableassertions&gt; nested
 * inside of a &lt;java&gt; task.
 * <br><br>
 * <b>Example:</b>
   <pre>
     &lt;java classname="test.Main"
           classpathref="project.classpath"&gt;
       &lt;enableassertions package="org.apache.tools.ant"/&gt;
       &lt;disableassertions classname="org.apache.tools.ant.BuildException"/&gt;
     &lt;/java&gt;
   </pre>
 *
 * This would enable assertions for the <code>org.apache.tools.ant</code>
 * package and all of its sub-packages and would disable assertions for
 * <code>org.apache.tools.ant.BuildException</code>.  The command line would
 * look like...<br><br>
 *
 * <code>java -ea:org.apache.tools.ant...
 * -da:org.apache.tools.ant.BuildException test.Main</code>
 * <br><br>
 * Refer to the J2SE tools documentation for more details on enabling and disabling
 * assertions.
 * @author Jeff Brown <a href="mailto:brown_j@ociweb.com">brown_j@ociweb.com</a>
 * @see org.apache.tools.ant.taskdefs.Java
 */
public class AssertionArgument {

    /**
     * The argument wrapped inside of this <code>AssertionArgument</code>
     */
    private Commandline.Argument argument;

    /**
     * The argument prefix for enabling assertions
     */
    public static final String ENABLE_ASSERTS_ARG  = "-ea";

    /**
     * The argument prefix for disabling assertions
     */
    public static final String DISABLE_ASSERTS_ARG = "-da";

    /**
     * The error message for the case when both a class attribute and a
     * package attribute are applied to a single
     * <code>AssertionArgument</code>
     */
    public static final String DUPLICATE_SPEC_ERR_MSG =
        "Cannot use 'package' and 'classname' attributes " +
        "in the same enableassert element.";

    /**
     * The prefix to the argument that will be passed on the command line
     */
    private final String assertionArgPrefix;

    /**
     * @param arg The <code>Commandline.Argument</code> being wrapped
     * @param enableAssertions <code>true</code> if this
     * <code>AssertionArgument</code> should be enabling assertions,
     * <code>false</code> if this <code>AssertionArgument</code> should be
     * disabling assertions
     */
    public AssertionArgument(Commandline.Argument arg,
                             boolean enableAssertions) {
        argument = arg;
        assertionArgPrefix = (enableAssertions ?
                              ENABLE_ASSERTS_ARG :
                              DISABLE_ASSERTS_ARG);
        argument.setLine(assertionArgPrefix);
    }

    /**
     * @param p The package to be specified on the command line
     */
    public void setPackage(String p) {
        // assertionArgPrefix will be either ENABLE_ASSERTS_ARG or
        // DISABLE_ASSERTS_ARG.  If the first part of argument is
        // NOT one of these two strings, then the class attribute
        // must have already been specified.  This is not legal.
        // Each AssertionArgument must have either
        //  1.) No specification applied (-de or -ea)
        //  2.) A class specification applied (-de:org.apache.test.Main)
        //  3.) A package specification applied (-de:org.apache.tools...)
        if(!(assertionArgPrefix.equals(argument.getParts()[0]))) {
            throw new BuildException(DUPLICATE_SPEC_ERR_MSG);
        }

        // set the command line argument
        argument.setLine(assertionArgPrefix + ":" + p + "...");
    }

    /**
     * @param c The class to be specified on the command line
     */
    public void setClassname(String c) {
        // assertionArgPrefix will be either ENABLE_ASSERTS_ARG or
        // DISABLE_ASSERTS_ARG.  If the first part of argument is
        // NOT one of these two strings, then the package attribute
        // must have already been specified.  This is not legal.
        // Each AssertionArgument must have either
        //  1.) No specification applied (-de or -ea)
        //  2.) A class specification applied (-de:org.apache.test.Main)
        //  3.) A package specification applied (-de:org.apache.tools...)
        if(!(assertionArgPrefix.equals(argument.getParts()[0]))) {
            throw new BuildException(DUPLICATE_SPEC_ERR_MSG);
        }

        // set the command line argument
        argument.setLine(assertionArgPrefix + ":" + c);
    }
}