FileStatusProvider (NetBeans VCS API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.vcscore.caching
Interface FileStatusProvider

public interface FileStatusProvider

The provider of VCS attributes of the file. These describes the status of the working file with respect to its repository version. Any method that returns the string representation of an VCS attribute of a file may return an empty string if that information is not available from the given version control system.

Method Summary

String getFileAttribute(String fullName)
          Get an additional attribute to a file.

String getFileDate(String fullName)
          Get the date of the last modification of a file.

String getFileLocker(String fullName)
          Get the locker of a single file.

String getFileRevision(String fullName)
          Get the revision of a file.

String getFileSize(String fullName)
          Get the size of a file as a string.

String getFileStatus(String fullName)
          Get the status of a single file.

FileStatusInfo getFileStatusInfo(String fullName)
          Get the status info of a single file.

String getFileSticky(String fullName)
          Get the sticky information of a file (i.e.

String getFileTime(String fullName)
          Get the time of the last modification of a file.

String getLocalFileStatus()


String getNotInSynchStatus()
          Get the status that is displayed instead of the attribute value, when this value differs for multiple files contained in the same data object file.

Set getPossibleFileStatusInfos()
          Get the set of all possible FileStatusInfo objects.

void refreshDir(String path)


void refreshDirRecursive(String path)


void setFileModified(String path)
          Should set the file as modified if it's version controlled.

void setFileStatus(String path, String status)

Method Detail

getPossibleFileStatusInfos

public Set getPossibleFileStatusInfos()

Get the set of all possible FileStatusInfo objects. This set is used in search service. The FileStatusInfo objects contains the original statuses (obtained from the VCS tool) as names.

getNotInSynchStatus

public String getNotInSynchStatus()

Get the status that is displayed instead of the attribute value, when this value differs for multiple files contained in the same data object file.

getFileStatus

public String getFileStatus(String fullName)

Get the status of a single file.

Parameters:: fullName - the name of the file with respect to the filesystem root.
Returns:: The original status (non-localized).

getFileStatusInfo

public FileStatusInfo getFileStatusInfo(String fullName)

Get the status info of a single file.

Parameters:: fullName - the name of the file with respect to the filesystem root.

getFileLocker

public String getFileLocker(String fullName)

Get the locker of a single file.

Parameters:: fullName - the name of the file with respect to the filesystem root.

getFileRevision

public String getFileRevision(String fullName)

Get the revision of a file.

Parameters:: fullName - the name of the file with respect to the filesystem root.

getFileSticky

public String getFileSticky(String fullName)

Get the sticky information of a file (i.e. the current branch).

Parameters:: fullName - the name of the file with respect to the filesystem root.

getFileAttribute

public String getFileAttribute(String fullName)

Get an additional attribute to a file. This attribute can be specific to the given version control system.

Parameters:: fullName - the name of the file with respect to the filesystem root.

getFileSize

public String getFileSize(String fullName)

Get the size of a file as a string.

Parameters:: fullName - the name of the file with respect to the filesystem root.

getFileDate

public String getFileDate(String fullName)

Get the date of the last modification of a file.

Parameters:: fullName - the name of the file with respect to the filesystem root.

getFileTime

public String getFileTime(String fullName)

Get the time of the last modification of a file.

Parameters:: fullName - the name of the file with respect to the filesystem root.

setFileStatus

public void setFileStatus(String path,
                          String status)

setFileModified

public void setFileModified(String path)

Should set the file as modified if it's version controlled.

getLocalFileStatus

public String getLocalFileStatus()

refreshDir

public void refreshDir(String path)

refreshDirRecursive

public void refreshDirRecursive(String path)