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.diff;
020
021import org.apache.maven.scm.CommandParameter;
022import org.apache.maven.scm.CommandParameters;
023import org.apache.maven.scm.ScmException;
024import org.apache.maven.scm.ScmFileSet;
025import org.apache.maven.scm.ScmResult;
026import org.apache.maven.scm.ScmVersion;
027import org.apache.maven.scm.command.AbstractCommand;
028import org.apache.maven.scm.provider.ScmProviderRepository;
029
030/**
031 * TODO: Better support for entire filesets.
032 * TODO: Better support for entire changesets (ie consistency between revision handling in SVN).
033 * TODO: Consistent handling of revisions, tags and dates - currently only revisions supported
034 *
035 * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
036 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
037 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
038 *
039 */
040public abstract class AbstractDiffCommand extends AbstractCommand {
041    protected abstract DiffScmResult executeDiffCommand(
042            ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion startRevision, ScmVersion endRevision)
043            throws ScmException;
044
045    /** {@inheritDoc} */
046    public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
047            throws ScmException {
048        ScmVersion startRevision = parameters.getScmVersion(CommandParameter.START_SCM_VERSION, null);
049
050        ScmVersion endRevision = parameters.getScmVersion(CommandParameter.END_SCM_VERSION, null);
051
052        return executeDiffCommand(repository, fileSet, startRevision, endRevision);
053    }
054}