Class: HistoryLine (private in HistoryManager

• Inheritance
• Description
• Related information
• Class protocol
  • converting
  • filtering
  • initialization
  • instance creation
  • private
• Instance protocol
  • accessing
  • comparing
  • printing & storing
  • queries
• Examples

Inheritance:

   Object
   |
   +--HistoryManager::HistoryLine

Package:

stx:libbasic3

Category:

System-Changes-History

Owner:

HistoryManager

Author:

Robert Sailer - AEG

Description:

The class HistoryLine is part of the HistoryManagerProjcet.

HistoryLine knows how to compose and parse comment lines which are
used to keep track of changes. These historyLines are added at the end of
a methods source code and to the special history classmethod.

HistoryLine and HistoryManager where generously provided by AEG for inclusion into the
ST/X class delivery.

Related information:

    HistoryManager

Class protocol:

 convertStringToDate: aString

kludge

 convertStringToTime: aString

kludge

 filterHistoryLines: aCollectionOfHistoryLines

check the collection against multiple occurrence of the same user,
and remove all but the youngest (per user).

 modificationLimit

Answer the number of seconds between creation and
modifcation of a method within which the modification
line won't be added.

 initialize

setup class variables

 fromString: aString

parses the argument, aString;
create & return a new Instance with the values

 fromString: aString at: position

parses the String and creates a new Instance with the values.
The positionvalue is normally used to remove the HistoryLines from the sourceCode.
Claus: return nil, if the string is not a valid historyString.

 new

get a new history line.
Preinitialize it as a modified-Line for the current user

 newCreated

public - get a new created-Line for the current user

 currentUserName

return the current users name -
thats either the userInfos-gecos field, or the users login name.

 type: type what: what

private - for integration purposes only

Instance protocol:

 date

return the date

 date: something

set the date

 firstPositionInSourceCode

return firstPositionInSourceCode

 firstPositionInSourceCode: something

set firstPositionInSourceCode

 isForAddition

 isForCreation

 isForDeletion

 isForModification

 time

return the time

 time: something

set the time

 type

return the type

 type: something

set the type

 user

return the user

 user: something

set the user

 what

return the what-changed info

 what: someStringOrSelector

set the what-changed info

 = aHistoryLine

compares two instances of HistoryLine

 hash

return a hash key for the receiver

 sameDate: aHistoryLine

returns true if aUserName = user in preperation for a SortedCollection of HistoryLines

 sameType: aHistoryLine

returns true if the Type = type in preperation for a SortedCollection of HistoryLines

 sameUser: aHistoryLine

returns true if aUserName = user in preperation for a SortedCollection of HistoryLines

 sameWhat: aHistoryLine

returns true if the what = type in preperation for a SortedCollection of HistoryLines

 printOn: aStream

return a printed representation of a HistoryLine as a string

 isCreated

returns true if the bodytext is CreatedString

 isDeleted

returns true if the bodytext is DeletedString

 isModified

returns true if the bodytext is ModifiedString

Examples: