#region "Nant Copyright notice"
// NAnt - A .NET build tool
// Copyright (C) 2001-2002 Gerry Shaw
//
// This program 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.
//
// This program 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.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// Clayton Harbour (claytonharbour@sporadicism.com)
#endregion

using System;

using NAnt.Core.Tasks;
using NAnt.Core.Attributes;

using ICSharpCode.SharpCvsLib.Commands;

namespace NAnt.Cvs.Tasks {

    /// <summary>
    ///     <remarks>
    ///         <para>Checks out the specified module to the required directory.</para>
    ///         <para>Takes a password parameter as an attribute.</para>
    ///     </remarks>
    ///         
    ///     <example>
    ///         <para>Checkout nant.</para>
    ///             <code>&lt;cvs-checkout destination="c:\src\nant\" cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant" password="" module="nant" /&gt;</code>
    ///         <para>Checkout your favorite build tool to the specified directory.</para>
    ///             <code>
    ///                 <![CDATA[
    ///                 <cvs-checkout destination="c:\src\nant\" cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant" password="" module="nant"/>
    ///                 ]]>
    ///             </code>
    ///     </example>
    /// </summary>
    [TaskName("cvs-checkout")]  
    public class CheckoutTask : AbstractCvsTask {
        /// <summary>
        /// Public constructor.
        /// </summary>
        public CheckoutTask() {

        }

        /// <summary>
        /// Creates the checkout command.
        /// </summary>
        /// <returns>An instance of the checkout command.</returns>
        protected override ICommand CreateCommand () {
            return
                new CheckoutModuleCommand (this.Working);
        }
    }
}