com.starbase.starteam
Class HistoryLine

java.lang.Object
  |
  +--com.starbase.starteam.LogLine
        |
        +--com.starbase.starteam.HistoryLine

public class HistoryLine

extends LogLine

A class containing information specific to a single version entry for expansion of the $History$ keyword.

Constructor Summary

HistoryLine(int version, java.lang.String viewName, java.lang.String dotNotation, OLEDate date, java.lang.String author, java.lang.String comment)
Creates new information for a single $History keyword entry.

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.lang.String	format(java.lang.String prefix, java.lang.String eol) Format and return a revision history record consisiting of the prefix, view name, dot notation, utc date, author and comment
int	hashCode() returns a unique hash for all instances of this type
java.lang.String	toXMLString() Returns an XML representation of the log line entry.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistoryLine

public HistoryLine(int version,
                   java.lang.String viewName,
                   java.lang.String dotNotation,
                   OLEDate date,
                   java.lang.String author,
                   java.lang.String comment)

Creates new information for a single $History keyword entry. Each revision of a file will have its own HistoryLine.

Parameters:

version - the version number for the revision

viewName - the name of the view in which the revision was created

dotNotation - the dot notation for the revision (for example "1.2.3.0")

date - the time at which the revision was created, in UTC

author - the name of the author of the revision

comment - the check-in comment for the revision

Method Detail

format

public java.lang.String format(java.lang.String prefix,
                               java.lang.String eol)

Format and return a revision history record consisiting of the prefix, view name, dot notation, utc date, author and comment

Parameters:

prefix - String the prefix to pre-pend to each history line, for instance '//' to signify a comment

eol - String the platform specific eol character; e.g. 'CR', 'LF' or 'CRLF'

Returns:

String a formatted line that can be written against the local file's history keyword

toXMLString

public java.lang.String toXMLString()

Returns an XML representation of the log line entry. The default XML representation is of the form:

 <logline>
     <version>1</version>
     <view>Main</view>
     <dotnotation>1.0</dotnotation>
     <date>2000-08-11T17:37:18Z</date>
     <author>Bob</author>
     <comment></comment>
 </logline>
 

Overrides:

toXMLString in class LogLine

Returns:

an XML representation of this log line entry

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class LogLine

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class LogLine

Returns:

int a unique hash for all instances of this type