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