buildframework/helium/sf/java/scm/src/com/nokia/maven/scm/manager/ExtendedScmManager.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.manager;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
import java.io.File;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import org.apache.maven.scm.ScmException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
import org.apache.maven.scm.manager.ScmManager;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
import org.apache.maven.scm.repository.ScmRepository;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    27
import com.nokia.maven.scm.command.info.InfoScmResult;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
import com.nokia.maven.scm.command.pull.PullScmResult;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
import com.nokia.maven.scm.command.tags.TagsScmResult;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
 * Extended verison of the Maven ScmManager
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
public interface ExtendedScmManager extends ScmManager
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
{
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
    String ROLE = ExtendedScmManager.class.getName();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
     * Download changes from remote repository.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
     *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
     * @param repository  the source control system
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
     * @param path     location of your local copy
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
     * @return
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
     * @throws ScmException if any
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
    PullScmResult pull(ScmRepository repository, File path)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
        throws ScmException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
     * Get the tag list.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
     *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
     * @param repository  the source control system
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
     * @param path     location of your local copy
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
     * @return
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
     * @throws ScmException if any
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
    TagsScmResult tags(ScmRepository repository, File path)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
        throws ScmException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
     * Get the global revision number for the repository.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
     *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
     * @param repository  the source control system
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
     * @param path     location of your local copy
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
     * @return
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
     * @throws ScmException if any
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
    InfoScmResult info(ScmRepository repository, File path)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
        throws ScmException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
}