org.echocat.gradle.plugins.golang.vcs

Class VcsRepositorySupport

java.lang.Object

org.echocat.gradle.plugins.golang.vcs.VcsRepositorySupport

All Implemented Interfaces:

VcsRepository

Direct Known Subclasses:

GitVcsRepository

public abstract class VcsRepositorySupport
extends java.lang.Object
implements VcsRepository

Nested Class Summary

Nested classes/interfaces inherited from interface org.echocat.gradle.plugins.golang.vcs.VcsRepository

VcsRepository.ProgressMonitor, VcsRepository.Utils

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VcsRepositorySupport(VcsReference reference)

Method Summary

Modifier and Type	Method and Description
protected abstract VcsFullReference	downloadToInternal(java.nio.file.Path targetDirectory, VcsRepository.ProgressMonitor progressMonitor)
protected void	emptyDirectoryIfExists(java.nio.file.Path directory)
VcsFullReference	forceUpdate(java.nio.file.Path baseDirectory)
VcsFullReference	forceUpdate(java.nio.file.Path baseDirectory, VcsRepository.ProgressMonitor progressMonitor)
VcsReference	getReference()
protected java.nio.file.Path	infoFileFor(java.nio.file.Path targetDirectory)
protected boolean	isUpdateRequired(java.nio.file.Path targetDirectory)
protected boolean	isUpdateRequired(VcsRepositoryInfo info)
protected java.nio.file.Path	resolveTargetDirectoryFor(java.nio.file.Path baseDirectory)
protected void	saveInfoFile(java.nio.file.Path targetDirectory, VcsFullReference fullReference)
protected void	saveInfoFile(java.nio.file.Path targetDirectory, VcsRepositoryInfo info)
protected VcsRepositoryInfo	tryReadInfoFor(java.nio.file.Path targetDirectory)
VcsFullReference	updateIfRequired(java.nio.file.Path baseDirectory)
VcsFullReference	updateIfRequired(java.nio.file.Path baseDirectory, VcsRepository.ProgressMonitor progressMonitor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.echocat.gradle.plugins.golang.vcs.VcsRepository

isWorking

Constructor Detail

VcsRepositorySupport

protected VcsRepositorySupport(@Nonnull
                               VcsReference reference)

Method Detail

getReference

@Nonnull
public VcsReference getReference()

Specified by:

getReference in interface VcsRepository

updateIfRequired

@Nullable
public VcsFullReference updateIfRequired(@Nonnull
                                                    java.nio.file.Path baseDirectory)
                                             throws VcsException

Specified by:

updateIfRequired in interface VcsRepository

Throws:

VcsException

updateIfRequired

@Nullable
public VcsFullReference updateIfRequired(@Nonnull
                                                    java.nio.file.Path baseDirectory,
                                                    @Nullable
                                                    VcsRepository.ProgressMonitor progressMonitor)
                                             throws VcsException

Specified by:

updateIfRequired in interface VcsRepository

Throws:

VcsException

forceUpdate

@Nonnull
public VcsFullReference forceUpdate(@Nonnull
                                              java.nio.file.Path baseDirectory)
                                       throws VcsException

Specified by:

forceUpdate in interface VcsRepository

Throws:

VcsException

forceUpdate

@Nonnull
public VcsFullReference forceUpdate(@Nonnull
                                              java.nio.file.Path baseDirectory,
                                              @Nullable
                                              VcsRepository.ProgressMonitor progressMonitor)
                                       throws VcsException

Specified by:

forceUpdate in interface VcsRepository

Throws:

VcsException

downloadToInternal

@Nonnull
protected abstract VcsFullReference downloadToInternal(@Nonnull
                                                                 java.nio.file.Path targetDirectory,
                                                                 @Nullable
                                                                 VcsRepository.ProgressMonitor progressMonitor)
                                                          throws VcsException

Throws:

VcsException

resolveTargetDirectoryFor

@Nonnull
protected java.nio.file.Path resolveTargetDirectoryFor(@Nonnull
                                                                 java.nio.file.Path baseDirectory)
                                                          throws VcsException

Throws:

VcsException

emptyDirectoryIfExists

protected void emptyDirectoryIfExists(@Nonnull
                                      java.nio.file.Path directory)
                               throws VcsException

Throws:

VcsException

infoFileFor

@Nonnull
protected java.nio.file.Path infoFileFor(@Nonnull
                                                   java.nio.file.Path targetDirectory)
                                            throws VcsException

Throws:

VcsException

tryReadInfoFor

@Nullable
protected VcsRepositoryInfo tryReadInfoFor(@Nonnull
                                                      java.nio.file.Path targetDirectory)
                                               throws VcsException

Throws:

VcsException

isUpdateRequired

protected boolean isUpdateRequired(@Nonnull
                                   java.nio.file.Path targetDirectory)
                            throws VcsException

Throws:

VcsException

isUpdateRequired

protected boolean isUpdateRequired(@Nullable
                                   VcsRepositoryInfo info)
                            throws VcsException

Throws:

VcsException

saveInfoFile

protected void saveInfoFile(@Nonnull
                            java.nio.file.Path targetDirectory,
                            @Nonnull
                            VcsRepositoryInfo info)
                     throws VcsException

Throws:

VcsException

saveInfoFile

protected void saveInfoFile(@Nonnull
                            java.nio.file.Path targetDirectory,
                            @Nonnull
                            VcsFullReference fullReference)
                     throws VcsException

Throws:

VcsException