org.netbeans.modules.versioning.spi
Interface VCSHistoryProvider

public interface VCSHistoryProvider

Provides history relevant data for versioned files.

Since:

1.29

Nested Class Summary

static interface	VCSHistoryProvider.HistoryChangeListener Listener to changes in a versioning history
static class	VCSHistoryProvider.HistoryEntry A history entry (revision) in a versioning repository.
static class	VCSHistoryProvider.HistoryEvent Event notifying a change in the history of some files.
static interface	VCSHistoryProvider.MessageEditProvider Implement and pass over to VCSHistoryProvider.HistoryEntry in case VCSHistoryProvider.HistoryEntry.setMessage(java.lang.String) is expected to work.
static interface	VCSHistoryProvider.ParentProvider Implement and pass over to a VCSHistoryProvider.HistoryEntry in case you want VCSHistoryProvider.HistoryEntry.getParentEntry(java.io.File) to return relevant values.
static interface	VCSHistoryProvider.RevisionProvider Implement and pass over to VCSHistoryProvider.HistoryEntry in case VCSHistoryProvider.HistoryEntry.getRevisionFile(java.io.File, java.io.File) is expected to work.

Method Summary

void	addHistoryChangeListener(VCSHistoryProvider.HistoryChangeListener l) Adds a listener for history change events.
Action	createShowHistoryAction(File[] files) Returns an action which is expected to open the particular versioning systems history view.
VCSHistoryProvider.HistoryEntry[]	getHistory(File[] files, Date fromDate) Returns a list of all HistoryEntries for the given files ranging between fromDate and now.
void	removeHistoryChangeListener(VCSHistoryProvider.HistoryChangeListener l) Removes a listener for history change events.

Method Detail

getHistory

VCSHistoryProvider.HistoryEntry[] getHistory(File[] files,
                                             Date fromDate)

Returns a list of all HistoryEntries for the given files ranging between fromDate and now.

Parameters:

files - the files for which the history should be returned

fromDate - timedate starting from which the history shoudl be returned

Returns:

a list of HistoryEntries

Since:

1.29

createShowHistoryAction

Action createShowHistoryAction(File[] files)

Returns an action which is expected to open the particular versioning systems history view.

Parameters:

files - the files for which the history view should be opened

Returns:

an action opening the history view or null if not available

Since:

1.29

addHistoryChangeListener

void addHistoryChangeListener(VCSHistoryProvider.HistoryChangeListener l)

Adds a listener for history change events.

Parameters:

l - listener

Since:

1.29

removeHistoryChangeListener

void removeHistoryChangeListener(VCSHistoryProvider.HistoryChangeListener l)

Removes a listener for history change events.

Parameters:

l - listener

Since:

1.29