org.codehaus.mojo.cobertura.tasks.CommandLineArguments Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cobertura-maven-plugin Show documentation

This is the Mojo's Maven plugin for Cobertura. Cobertura is a free Java tool that calculates the percentage of code accessed by tests. It can be used to identify which parts of your Java program are lacking test coverage.

There is a newer version: 2.7

Show newest version

package org.codehaus.mojo.cobertura.tasks;

/*
 * Copyright 2011
 *
 * 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.
 */
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import net.sourceforge.cobertura.util.CommandLineBuilder;

/**
 * CommandLineArguments allows for arbitrarily long command line argument lists.
 * 
 * @author Joakim Erdfelt
 */
public class CommandLineArguments
{
    private List args;

    private boolean useCommandsFile;

    /**
     * Construct empty arg set.
     */
    public CommandLineArguments()
    {
        this.args = new ArrayList();
        this.useCommandsFile = false;
    }

    /**
     * Append an option.
     * @param arg the argument.
     */
    public void addArg( String arg )
    {
        this.args.add( arg );
    }

    /**
     * Append two arguments (e.g. -x y)
     * @param arg1 first arg
     * @param arg2 second arg.
     */
    public void addArg( String arg1, String arg2 )
    {
        this.args.add( arg1 );
        this.args.add( arg2 );
    }

    /**
     * @return the list of arg strings.
     */
    public List getArgs()
    {
        return this.args;
    }

    /**
     * Generate the Commands file and return the filename to it.
     * 
     * @return the commands filename.
     * @throws IOException error writing the file.
     */
    public String getCommandsFile()
        throws IOException
    {
        CommandLineBuilder builder = new CommandLineBuilder();
        for ( String arg : this.args )
        {
            builder.addArg( arg );
        }
        builder.saveArgs();
        return builder.getCommandLineFile();
    }

    /**
     * @return an iterator over the arg strings.
     */
    public Iterator iterator()
    {
        return this.args.iterator();
    }

    /**
     * @param useCommandsFile The useCommandsFile to set.
     */
    public void setUseCommandsFile( boolean useCommandsFile )
    {
        this.useCommandsFile = useCommandsFile;
    }

    /**
     * @return Returns the useCommandsFile.
     */
    public boolean useCommandsFile()
    {
        return useCommandsFile;
    }
}