001    package org.apache.maven.scm.command;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     * http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.maven.scm.CommandParameters;
023    import org.apache.maven.scm.ScmException;
024    import org.apache.maven.scm.ScmFileSet;
025    import org.apache.maven.scm.ScmResult;
026    import org.apache.maven.scm.log.ScmLogger;
027    import org.apache.maven.scm.provider.ScmProviderRepository;
028    
029    /**
030     * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
031     * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
032     *
033     */
034    public interface Command
035    {
036        /** Plexus component key */
037        String ROLE = Command.class.getName();
038    
039        /**
040         * @param repository not null
041         * @param fileSet not null
042         * @param parameters could be null
043         * @return the result object
044         * @throws ScmException if any
045         */
046        ScmResult execute( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
047            throws ScmException;
048    
049        /**
050         * @param logger not null
051         */
052        void setLogger( ScmLogger logger );
053    
054        /**
055         * @return the current logger
056         */
057        ScmLogger getLogger();
058    }