Top Description Inners Constructors Methods
org.apache.tools.ant.taskdefs.optional.vss

public Class MSVSSHISTORY

extends MSVSS
Class Inheritance
Imports
java.io.File, java.text.SimpleDateFormat, org.apache.tools.ant.BuildException, org.apache.tools.ant.types.Commandline, .EnumeratedAttribute
Performs History commands to Microsoft Visual SourceSafe.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
MSVSSHISTORY.BriefCodediffNofile

Extension of EnumeratedAttribute to hold the values for style.

Constructor Summary

AccessConstructor and Description
public
MSVSSHISTORY()

Method Summary

Modifier and TypeMethod and Description
pack-priv Commandline

Returns:

The constructed commandline.
buildCmdLine()

Implements abstract org.apache.tools.ant.taskdefs.optional.vss.MSVSS.buildCmdLine.

Builds a command line to execute ss.
public void
setDateFormat(String
The date format.
dateFormat)

Format of dates in fromDate and toDate.

public void
setFromDate(String
The start date.
fromDate)

Date representing the 'start' of the range.

public void
setFromLabel(String
The start label.
fromLabel)

Label representing the 'start' of the range.

public void
setNumdays(int
The number of days.
numd)

Number of days for comparison.

public void
setOutput(File
The output file name.
outfile)

Output file name for the history.

public void
setRecursive(boolean
The boolean value for recursive.
recursive)

Retrieve history recursively.

public void
setStyle(MSVSSHISTORY.BriefCodediffNofile
The history style:
attr)

Output style.

public void
setToDate(String
The end date.
toDate)

Date representing the 'end' of the range.

public void
setToLabel(String
The end label.
toLabel)

Label representing the 'end' of the range.

public void
setUser(String
The username.
user)

Name of the user whose change history is generated.

Inherited from org.apache.tools.ant.taskdefs.optional.vss.MSVSS:
executegetAutoresponsegetCommentgetFileTimeStampgetGetLocalCopygetLabelgetLocalpathgetLogingetOutputgetQuietgetRecursivegetSSCommandgetStylegetUsergetVersiongetVersionDategetVersionDateLabelgetVersionLabelgetVsspathgetWritablegetWritableFilessetFailOnErrorsetInternalAutoResponsesetInternalCommentsetInternalDatesetInternalDateFormatsetInternalFailOnErrorsetInternalFileTimeStampsetInternalFromDatesetInternalFromLabelsetInternalGetLocalCopysetInternalLabelsetInternalLocalPathsetInternalNumDayssetInternalOutputFilenamesetInternalQuietsetInternalRecursivesetInternalStylesetInternalToDatesetInternalToLabelsetInternalUsersetInternalVersionsetInternalWritablesetInternalWritableFilessetLoginsetServerpathsetSsdirsetVsspath

Constructor Detail

MSVSSHISTORYback to summary
public MSVSSHISTORY()

Method Detail

buildCmdLineback to summary
pack-priv Commandline buildCmdLine()

Implements abstract org.apache.tools.ant.taskdefs.optional.vss.MSVSS.buildCmdLine.

Builds a command line to execute ss.

Returns:Commandline

The constructed commandline.

setDateFormatback to summary
public void setDateFormat(String dateFormat)

Format of dates in fromDate and toDate. Used when calculating dates with the numdays attribute. This string uses the formatting rules of SimpleDateFormat. Defaults to DateFormat.SHORT.

Parameters
dateFormat:String

The date format.

setFromDateback to summary
public void setFromDate(String fromDate)

Date representing the 'start' of the range.

Parameters
fromDate:String

The start date.

setFromLabelback to summary
public void setFromLabel(String fromLabel)

Label representing the 'start' of the range.

Parameters
fromLabel:String

The start label.

setNumdaysback to summary
public void setNumdays(int numd)

Number of days for comparison. Defaults to 2 days.

Parameters
numd:int

The number of days.

setOutputback to summary
public void setOutput(File outfile)

Output file name for the history.

Parameters
outfile:File

The output file name.

setRecursiveback to summary
public void setRecursive(boolean recursive)

Retrieve history recursively. Defaults to false.

Parameters
recursive:boolean

The boolean value for recursive.

setStyleback to summary
public void setStyle(MSVSSHISTORY.BriefCodediffNofile attr)

Output style. Valid options are:

  • brief: -B Display a brief history.
  • codediff: -D Display line-by-line file changes.
  • nofile: -F- Do not display individual file updates in the project history.
  • default: No option specified. Display in Source Safe's default format.
Parameters
attr:MSVSSHISTORY.BriefCodediffNofile

The history style:

setToDateback to summary
public void setToDate(String toDate)

Date representing the 'end' of the range.

Parameters
toDate:String

The end date.

setToLabelback to summary
public void setToLabel(String toLabel)

Label representing the 'end' of the range.

Parameters
toLabel:String

The end label.

setUserback to summary
public void setUser(String user)

Name of the user whose change history is generated.

Parameters
user:String

The username.

org.apache.tools.ant.taskdefs.optional.vss back to summary

public Class MSVSSHISTORY.BriefCodediffNofile

extends EnumeratedAttribute
Class Inheritance
Extension of EnumeratedAttribute to hold the values for style.

Field Summary

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:
value

Constructor Summary

AccessConstructor and Description
public
BriefCodediffNofile()

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

The values.
getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

Gets the list of allowable values.
Inherited from org.apache.tools.ant.types.EnumeratedAttribute:
containsValuegetIndexgetInstancegetValueindexOfValuesetValuetoString

Constructor Detail

BriefCodediffNofileback to summary
public BriefCodediffNofile()

Method Detail

getValuesback to summary
public String[] getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

Gets the list of allowable values.

Returns:String[]

The values.