com.starbase.starteam
Class LogLine

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

Direct Known Subclasses:

HistoryLine

public class LogLine

extends java.lang.Object

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

Constructor Summary

LogLine(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 $Log keyword entry.

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
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

LogLine

public LogLine(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 $Log keyword entry. Each revision of a file will have its own LogLine.

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

author - the name of the author of the revision

comment - the check-in comment for the revision

Method Detail

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>
 

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 java.lang.Object

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 java.lang.Object

Returns:

int a unique hash for all instances of this type