buildframework/helium/sf/java/scm/src/com/nokia/maven/scm/command/tags/AbstractTagsCommand.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
* All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
* This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
* which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
* Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
* Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
* Description:  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
*/
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
package com.nokia.maven.scm.command.tags;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
import org.apache.maven.scm.CommandParameters;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
import org.apache.maven.scm.ScmException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import org.apache.maven.scm.ScmFileSet;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
import org.apache.maven.scm.command.AbstractCommand;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
import org.apache.maven.scm.provider.ScmProviderRepository;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    27
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
 * Abstract class representing a tags command. 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
 * Tags consist in retrieving existing tags for a particular repository.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
public abstract class AbstractTagsCommand extends AbstractCommand
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
{
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
     * {@inheritDoc} 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
    public TagsScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet,
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
            CommandParameters parameters) throws ScmException
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
    {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
        return executeTagsCommand(repository, fileSet, parameters);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
     * Execute the tags operation on the repository.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
     * @param repository the repository to use for the action
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
     * @param fileSetCommand 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
     * @param parameters
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
     * @return a TagsScmResult representing the output of the command.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
     * @throws ScmException
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
    protected abstract TagsScmResult executeTagsCommand(ScmProviderRepository repository, ScmFileSet fileSetCommand, CommandParameters parameters) throws ScmException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
}