org.apache.maven.scm.provider.vss.commands
Class VssParameterContext

java.lang.Object
  org.apache.maven.scm.provider.vss.commands.VssParameterContext

public class VssParameterContext
extends Object

Version:

$Id: VssParameterContext.java 687495 2008-08-20 22:54:52Z olamy $

Author:

Thorsten Riek

Constructor Summary

VssParameterContext(VssScmProviderRepository repo)

Method Summary

String	getAutoresponse() Gets the auto response string.
String	getComment() Gets the comment string.
String	getFileTimeStamp() Gets the value set for the FileTimeStamp. if it equals "current" then we return -GTC if it equals "modified" then we return -GTM if it equals "updated" then we return -GTU otherwise we return -GTC
String	getGetLocalCopy() Builds and returns the -G- flag if required.
static VssParameterContext	getInstance(Object obj)
String	getLabel() Gets the label string.
String	getLocalpath() Gets the localpath string.
String	getLogin() Gets the login string.
String	getOutput() Gets the output file string.
String	getQuiet() Gets the quiet string.
String	getRecursive() Gets the recursive string.
String	getSSCommand() Gets the sscommand string.
String	getStyle() Gets the style string.
String	getUser() Gets the user string.
String	getVersion() Gets the version string.
String	getVersionDate() Gets the Version date string.
String	getVersionDateLabel() Gets the version string.
String	getVersionLabel()
String	getVssPath()
String	getWritable() Gets the writable string.
String	getWritableFiles() Gets the value to determine the behaviour when encountering writable files.

Methods inherited from class java.lang.Object

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

Constructor Detail

VssParameterContext

public VssParameterContext(VssScmProviderRepository repo)

Method Detail

getInstance

public static VssParameterContext getInstance(Object obj)

getGetLocalCopy

public String getGetLocalCopy()

Builds and returns the -G- flag if required.

Returns:

An empty string if get local copy is true.

getFileTimeStamp

public String getFileTimeStamp()

Gets the value set for the FileTimeStamp. if it equals "current" then we return -GTC if it equals "modified" then we return -GTM if it equals "updated" then we return -GTU otherwise we return -GTC

Returns:

The default file time flag, if not set.

getLocalpath

public String getLocalpath()
                    throws ScmException

Gets the localpath string. "-GLc:\source"

The localpath is created if it didn't exist.

Returns:

An empty string if localpath is not set.

Throws:

ScmException

getLabel

public String getLabel()

Gets the label string. "-Lbuild1" Max label length is 32 chars

Returns:

An empty string if label is not set.

getVersionDateLabel

public String getVersionDateLabel()

Gets the version string. Returns the first specified of version "-V1.0", date "-Vd01.01.01", label "-Vlbuild1".

Returns:

An empty string if a version, date and label are not set.

getVersion

public String getVersion()

Gets the version string.

Returns:

An empty string if a version is not set.

getStyle

public String getStyle()

Gets the style string. "-Lbuild1"

Returns:

An empty string if label is not set.

getRecursive

public String getRecursive()

Gets the recursive string. "-R"

Returns:

An empty string if recursive is not set or is false.

getWritable

public String getWritable()

Gets the writable string. "-W"

Returns:

An empty string if writable is not set or is false.

getQuiet

public String getQuiet()

Gets the quiet string. -O-

Returns:

An empty string if quiet is not set or is false.

getVersionLabel

public String getVersionLabel()

getUser

public String getUser()

Gets the user string. "-Uusername"

Returns:

An empty string if user is not set.

getComment

public String getComment()

Gets the comment string. "-Ccomment text"

Returns:

A comment of "-" if comment is not set.

getLogin

public String getLogin()

Gets the login string. This can be user and password, "-Yuser,password" or just user "-Yuser".

Returns:

An empty string if login is not set.

getAutoresponse

public String getAutoresponse()

Gets the auto response string. This can be Y "-I-Y" or N "-I-N".

Returns:

The default value "-I-" if autoresponse is not set.

getSSCommand

public String getSSCommand()

Gets the sscommand string. "ss" or "c:\path\to\ss"

Returns:

The path to ss.exe or just ss if sscommand is not set.

getVssPath

public String getVssPath()

getVersionDate

public String getVersionDate()
                      throws ScmException

Gets the Version date string.

Returns:

An empty string if neither Todate or from date are set.

Throws:

ScmException

getOutput

public String getOutput()

Gets the output file string. "-Ooutput.file"

Returns:

An empty string if user is not set.

getWritableFiles

public String getWritableFiles()

Gets the value to determine the behaviour when encountering writable files.

Returns:

An empty String, if not set.