org.netbeans.modules.versioning.spi

Class VCSHistoryProvider.HistoryEntry

java.lang.Object

org.netbeans.modules.versioning.spi.VCSHistoryProvider.HistoryEntry

Enclosing interface:

VCSHistoryProvider

public static final class VCSHistoryProvider.HistoryEntry
extends Object

A history entry (revision) in a versioning repository. As such sometimes may apply for more then one file, it is also expected that only one instance, containing all relevant files, is created in such case.

The usernameShort and revisionShort will be displayed in places with limited space, but should be descriptive enough to identify the particular user or revision - e.g in case of Mercurial it would be something like: e border="0"

example of output for Mercurial

	short	long
revision	210767	210767:2dd617e260fc
user	john.doe@netbeans.org	John Doe <john.doe@netbeans.org>

Since:

1.29

Constructor Summary

Constructors

Constructor and Description
HistoryEntry(File[] files, Date dateTime, String message, String username, String usernameShort, String revision, String revisionShort, Action[] actions, VCSHistoryProvider.RevisionProvider revisionProvider) Creates a new HistoryEntry instance.
HistoryEntry(File[] files, Date dateTime, String message, String username, String usernameShort, String revision, String revisionShort, Action[] actions, VCSHistoryProvider.RevisionProvider revisionProvider, VCSHistoryProvider.MessageEditProvider messageEditProvider) Creates a new HistoryEntry instance.
HistoryEntry(File[] files, Date dateTime, String message, String username, String usernameShort, String revision, String revisionShort, Action[] actions, VCSHistoryProvider.RevisionProvider revisionProvider, VCSHistoryProvider.MessageEditProvider messageEditProvider, VCSHistoryProvider.ParentProvider parentProvider) Creates a new HistoryEntry instance.

Method Summary

Modifier and Type	Method and Description
boolean	canEdit() Determines if this HistoryEntry instance supports changes.
Action[]	getActions() Returns actions which might be called for this HistoryEntry as it is presented in the history view. It is ensured that if the returned actions are a ContextAwareAction, they will be provided with a context containing the nodes selected in the history view.
Date	getDateTime() Returns the date and time when this HistoryEntry was created in the versioning repository.
File[]	getFiles() Returns the files this HistoryEntry applies to.
String	getMessage() Returns the message describing the HistoryEntry.
VCSHistoryProvider.HistoryEntry	getParentEntry(File file) Returns this revisions parent entry or null if not available.
String	getRevision() Returns the full form of the revision value which identifies this HistoryEntry in the relevant versionig repository.
void	getRevisionFile(File originalFile, File revisionFile) Get the copy of a file as it was in the revision given by this HistoryEntry.
String	getRevisionShort() Returns the short form of the revision value which identifies this HistoryEntry in the relevant versionig repository.
String	getUsername() Returns the full form of the users name which created this HistoryEntry in the versioning system.
String	getUsernameShort() Returns a short form of the users name which created this HistoryEntry in the versioning system.
void	setMessage(String message) Changes the message for this HistoryEntry in the relevant versioning system in case this a MessageEditProvider instance was passed into the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryEntry

public HistoryEntry(File[] files,
                    Date dateTime,
                    String message,
                    String username,
                    String usernameShort,
                    String revision,
                    String revisionShort,
                    Action[] actions,
                    VCSHistoryProvider.RevisionProvider revisionProvider)

Creates a new HistoryEntry instance.

Parameters:

files - involved files

dateTime - the date and time when the versioning revision was created

message - the message describing the versioning revision

username - full description of the user who created the versioning revision

usernameShort - short description of the user who created the versioning revision

revision - full description of the versioning revision

revisionShort - short description of the versioning revision

actions - actions which might be called in regard with this revision

revisionProvider - a RevisionProvider to get access to a files contents in this revision

Since:

1.29

HistoryEntry

public HistoryEntry(File[] files,
                    Date dateTime,
                    String message,
                    String username,
                    String usernameShort,
                    String revision,
                    String revisionShort,
                    Action[] actions,
                    VCSHistoryProvider.RevisionProvider revisionProvider,
                    VCSHistoryProvider.MessageEditProvider messageEditProvider)

Creates a new HistoryEntry instance.

Parameters:

files - involved files

dateTime - the date and time when the versioning revision was created

message - the message describing the versioning revision

username - full description of the user who created the versioning revision

usernameShort - short description of the user who created the versioning revision

revision - full description of the versioning revision

revisionShort - short description of the versioning revision

actions - actions which might be called in regard with this revision

revisionProvider - a RevisionProvider to get access to a files contents in this revision

messageEditProvider - a MessageEditProvider to change a revisions message

Since:

1.29

HistoryEntry

public HistoryEntry(File[] files,
                    Date dateTime,
                    String message,
                    String username,
                    String usernameShort,
                    String revision,
                    String revisionShort,
                    Action[] actions,
                    VCSHistoryProvider.RevisionProvider revisionProvider,
                    VCSHistoryProvider.MessageEditProvider messageEditProvider,
                    VCSHistoryProvider.ParentProvider parentProvider)

Creates a new HistoryEntry instance.

Parameters:

files - involved files

dateTime - the date and time when the versioning revision was created

message - the message describing the versioning revision

username - full description of the user who created the versioning revision

usernameShort - short description of the user who created the versioning revision

revision - full description of the versioning revision

revisionShort - short description of the versioning revision

actions - actions which might be called in regard with this revision

revisionProvider - a RevisionProvider to get access to a files contents in this revision

messageEditProvider - a MessageEditProvider to change a revisions message

parentProvider - a ParentProvider to provide this entries parent entry. Not necessary for VCS where a revisions parent always is the time nearest previous revision.

Since:

1.30

Method Detail

canEdit

public boolean canEdit()

Determines if this HistoryEntry instance supports changes.

Returns:

true if it is possible to access setter methods in this instance

Since:

1.29

getDateTime

public Date getDateTime()

Returns the date and time when this HistoryEntry was created in the versioning repository.

Returns:

the date and time

Since:

1.29

getMessage

public String getMessage()

Returns the message describing the HistoryEntry.

Returns:

the message describing the HistoryEntry.

Since:

1.29

setMessage

public void setMessage(String message)
                throws IOException

Changes the message for this HistoryEntry in the relevant versioning system in case this a MessageEditProvider instance was passed into the constructor.

Parameters:

message - new message text

Throws:

IOException - if it wasn't possible to set the message

IllegalStateException - if no VCSHistoryProvider.MessageEditProvider was passed to this HistoryEntry instance

Since:

1.29

getFiles

public File[] getFiles()

Returns the files this HistoryEntry applies to.

Returns:

a fields of files

Since:

1.29

getUsername

public String getUsername()

Returns the full form of the users name which created this HistoryEntry in the versioning system.

Returns:

the full form of the users name

Since:

1.29

getUsernameShort

public String getUsernameShort()

Returns a short form of the users name which created this HistoryEntry in the versioning system.

Returns:

Since:

1.29

getRevision

public String getRevision()

Returns the full form of the revision value which identifies this HistoryEntry in the relevant versionig repository.

Returns:

Since:

1.29

getRevisionShort

public String getRevisionShort()

Returns the short form of the revision value which identifies this HistoryEntry in the relevant versionig repository.

Returns:

Since:

1.29

getActions

public Action[] getActions()

Returns actions which might be called for this HistoryEntry as it is presented in the history view.
It is ensured that if the returned actions are a ContextAwareAction, they will be provided with a context containing the nodes selected in the history view. The lookup of those nodes will again contain the relevant VCSHistoryProvider.HistoryEntry and File-s for which the action should be invoked.

Returns:

a field of actions

Since:

1.31

getRevisionFile

public void getRevisionFile(File originalFile,
                            File revisionFile)

Get the copy of a file as it was in the revision given by this HistoryEntry. In case a VCSHistoryProvider.RevisionProvider wasn't provided this method does nothing.

Parameters:

originalFile - placeholder File for the original (unmodified) copy of the working file

revisionFile - a File in the working copy

Since:

1.29

getParentEntry

public VCSHistoryProvider.HistoryEntry getParentEntry(File file)

Returns this revisions parent entry or null if not available.

Parameters:

file - the file for whitch the parent HistoryEntry should be returned

Returns:

this revisions parent entry

Since:

1.30