Package hudson.plugins.jobConfigHistory

Class HistoryDescr

java.lang.Object

hudson.plugins.jobConfigHistory.HistoryDescr

All Implemented Interfaces:

ParsedDate

Direct Known Subclasses:

LazyHistoryDescr

public class HistoryDescr
extends Object
implements ParsedDate

Holder for information about an altering operation saved to JobConfigHistoryConsts.HISTORY_FILE.

Author:

Stefan Brausch

Field Summary

Fields

Modifier and Type	Field	Description
static final HistoryDescr	EMPTY_HISTORY_DESCR

Constructor Summary

Constructors

Constructor	Description
HistoryDescr(String user, String userId, String operation, String timestamp, String currentName, String oldName)
HistoryDescr(String user, String userId, String operation, String timestamp, String currentName, String oldName, String changeReasonComment)

Method Summary

Modifier and Type	Method	Description
String	getChangeReasonComment()
String	getCurrentName()	Returns the current job name after renaming.
String	getOldName()	Returns the old job name before renaming.
String	getOperation()	Returns name of the operation.
String	getTimestamp()	Returns timestamp of the operation.
String	getUser()	Returns display name of the user doing the operation.
String	getUserID()	Returns id of the user doing the operation.
Date	parsedDate()	Returns a Date.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_HISTORY_DESCR

public static final HistoryDescr EMPTY_HISTORY_DESCR

Constructor Details

HistoryDescr

public HistoryDescr(String user,
 String userId,
 String operation,
 String timestamp,
 String currentName,
 String oldName)

Parameters:

user - display name of the user doing the operation

userId - id of the user doing the operation

operation - name of the operation

timestamp - timestamp of the operation

currentName - the current name after renaming

oldName - the name before renaming

HistoryDescr

public HistoryDescr(String user,
 String userId,
 String operation,
 String timestamp,
 String currentName,
 String oldName,
 String changeReasonComment)

Parameters:

user - display name of the user doing the operation

userId - id of the user doing the operation

operation - name of the operation

timestamp - timestamp of the operation

currentName - the current name after renaming

oldName - the name before renaming

Method Details

getUser

public String getUser()

Returns display name of the user doing the operation.

Returns:

display name of the user

getUserID

public String getUserID()

Returns id of the user doing the operation.

Returns:

id of the user

getOperation

public String getOperation()

Returns name of the operation.

Returns:

name of the operation

getTimestamp

public String getTimestamp()

Returns timestamp of the operation.

Returns:

timestamp

parsedDate

public Date parsedDate()

Returns a Date.

Specified by:

parsedDate in interface ParsedDate

Returns:

The parsed date as a java.util.Date.

getCurrentName

public String getCurrentName()

Returns the current job name after renaming.

Returns:

the current job name

getOldName

public String getOldName()

Returns the old job name before renaming.

Returns:

the old job name

toString

public String toString()

Overrides:

toString in class Object

getChangeReasonComment

public String getChangeReasonComment()

Returns:

the comment on why the config has been changed. null, if not given.