Class ChangeLogSet.Entry
- Enclosing class:
ChangeLogSet<T extends ChangeLogSet.Entry>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCollection<? extends ChangeLogSet.AffectedFile> Returns a set of paths in the workspace that was affected by this change.abstract Collection<String> Returns a set of paths in the workspace that was affected by this change.abstract UserThe user who made this change.Gets the full commit message or comment.Returns a human readable display name of the commit number, revision number, and such thing that identifies this entry.abstract StringgetMsg()Gets the "commit message".Gets the text fully marked up byChangeLogAnnotator.Message escaped for HTMLlongReturns the timestamp of this commit in theDate.getTime()format.protected voidsetParent(ChangeLogSet parent) Should be invoked before aChangeLogSetis exposed to public.
-
Constructor Details
-
Entry
public Entry()
-
-
Method Details
-
getParent
-
setParent
Should be invoked before aChangeLogSetis exposed to public. -
getCommitId
Returns a human readable display name of the commit number, revision number, and such thing that identifies this entry.This method is primarily intended for visualization of the data.
- Returns:
- null if such a concept doesn't make sense for the implementation. For example, in CVS there's no single identifier for commits. Each file gets a different revision number.
- Since:
- 1.405
-
getTimestamp
@Exported public long getTimestamp()Returns the timestamp of this commit in theDate.getTime()format.This method is primarily intended for visualization of the data.
- Returns:
- -1 if the implementation doesn't support it (for example, in CVS a commit spreads over time between multiple changes on multiple files, so there's no single timestamp.)
- Since:
- 1.405
-
getMsg
Gets the "commit message".The exact definition depends on the individual SCM implementation.
- Returns:
- Can be empty but never null.
-
getComment
Gets the full commit message or comment.While
getMsg()may return a summary or first line of the commit message in some SCM implementations, this method returns the entire comment where available. The default implementation returnsgetMsg().- Returns:
- the full commit message, or
getMsg()if not distinguished. Can be empty but never null. - Since:
- TODO
-
getAuthor
The user who made this change.- Returns:
- never null.
-
getAffectedPaths
Returns a set of paths in the workspace that was affected by this change.Contains string like 'foo/bar/zot'. No leading/trailing '/', and separator must be normalized to '/'.
- Returns:
- never null.
-
getAffectedFiles
Returns a set of paths in the workspace that was affected by this change.Noted: since this is a new interface, some of the SCMs may not have implemented this interface. The default implementation for this interface is throw UnsupportedOperationException
It doesn't throw NoSuchMethodException because I rather to throw a runtime exception
- Returns:
- AffectedFile never null.
- Since:
- 1.309
-
getMsgAnnotated
Gets the text fully marked up byChangeLogAnnotator. -
getMsgEscaped
Message escaped for HTML
-