hudson.scm
Class SubversionSCM.ModuleLocation

java.lang.Object
  hudson.scm.SubversionSCM.ModuleLocation

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

SubversionSCM

@ExportedBean
public static final class SubversionSCM.ModuleLocation
extends java.lang.Object
implements java.io.Serializable

small structure to store local and remote (repository) location information of the repository. As a addition it holds the invalid field to make failure messages when doing a checkout possible

See Also:

Serialized Form

Field Summary

java.lang.String	local Deprecated. Code should use getLocalDir(). This field is only intended for form binding.
java.lang.String	remote Subversion URL to check out.

Constructor Summary

SubversionSCM.ModuleLocation(java.lang.String remote, java.lang.String local)

Method Summary

SubversionSCM.ModuleLocation	getExpandedLocation(hudson.model.AbstractBuild<?,?> build) Expand location value based on Build parametric execution.
java.lang.String	getLocalDir() Local directory to place the file to.
org.tmatesoft.svn.core.SVNURL	getRepositoryRoot(hudson.model.AbstractProject context)
org.tmatesoft.svn.core.wc.SVNRevision	getRevision(org.tmatesoft.svn.core.wc.SVNRevision defaultValue) Figures out which revision to check out.
org.tmatesoft.svn.core.SVNURL	getSVNURL() Gets remote as SVNURL.
java.lang.String	getURL() Returns the pure URL portion of remote by removing possible "@NNN" suffix.
java.util.UUID	getUUID(hudson.model.AbstractProject context) Repository UUID.
org.tmatesoft.svn.core.io.SVNRepository	openRepository(hudson.model.AbstractProject context)
static java.util.List<SubversionSCM.ModuleLocation>	parse(java.lang.String[] remoteLocations, java.lang.String[] localLocations)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

remote

@Exported
public final java.lang.String remote

Subversion URL to check out. This may include "@NNN" at the end to indicate a fixed revision.

local

@Exported
public final java.lang.String local

Deprecated. Code should use getLocalDir(). This field is only intended for form binding.

Remembers the user-given value. Can be null.

Constructor Detail

SubversionSCM.ModuleLocation

@DataBoundConstructor
public SubversionSCM.ModuleLocation(java.lang.String remote,
                                                         java.lang.String local)

Method Detail

getLocalDir

public java.lang.String getLocalDir()

Local directory to place the file to. Relative to the workspace root.

getURL

public java.lang.String getURL()

Returns the pure URL portion of remote by removing possible "@NNN" suffix.

getSVNURL

public org.tmatesoft.svn.core.SVNURL getSVNURL()
                                        throws org.tmatesoft.svn.core.SVNException

Gets remote as SVNURL.

Throws:

org.tmatesoft.svn.core.SVNException

getUUID

public java.util.UUID getUUID(hudson.model.AbstractProject context)
                       throws org.tmatesoft.svn.core.SVNException

Repository UUID. Lazy computed and cached.

Throws:

org.tmatesoft.svn.core.SVNException

openRepository

public org.tmatesoft.svn.core.io.SVNRepository openRepository(hudson.model.AbstractProject context)
                                                       throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getRepositoryRoot

public org.tmatesoft.svn.core.SVNURL getRepositoryRoot(hudson.model.AbstractProject context)
                                                throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getRevision

public org.tmatesoft.svn.core.wc.SVNRevision getRevision(org.tmatesoft.svn.core.wc.SVNRevision defaultValue)

Figures out which revision to check out. If remote is url@rev, then this method returns that specific revision.

Parameters:

defaultValue - If "@NNN" portion is not in the URL, this value will be returned. Normally, this is the SVN revision timestamped at the build date.

getExpandedLocation

public SubversionSCM.ModuleLocation getExpandedLocation(hudson.model.AbstractBuild<?,?> build)

Expand location value based on Build parametric execution.

Parameters:

build - Build instance for expanding parameters into their values

Returns:

Output ModuleLocation expanded according to Build parameters values.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parse

public static java.util.List<SubversionSCM.ModuleLocation> parse(java.lang.String[] remoteLocations,
                                                                 java.lang.String[] localLocations)