org.netbeans.modules.versioning.core.api

Class VersioningSupport

java.lang.Object

org.netbeans.modules.versioning.core.api.VersioningSupport

public final class VersioningSupport
extends Object

Collection of utility methods for Versioning systems implementors.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREF_BOOLEAN_TEXT_ANNOTATIONS_VISIBLE Boolean property defining visibility of textual versioning annotations (aka Status Labels).

Method Summary

Modifier and Type	Method and Description
static ProcessBuilder	createProcessBuilder(VCSFileProxy file) Creates Process builder.
static VersioningSystem	getOwner(VCSFileProxy file) Queries the Versioning infrastructure for file ownership.
static Preferences	getPreferences() Common settings and preferences for versioning modules are set in this preferences node.
static boolean	isExcluded(VCSFileProxy folder) Tests whether the given folder is excluded (unversioned) from version control.
static boolean	isFlat(VCSFileProxy file) Tests whether the given file represents a flat folder (eg a java package), that is a folder that contains only its direct children.
static boolean	isTextAnnotationVisible() Returns the value of VersioningSupport.PREF_BOOLEAN_TEXT_ANNOTATIONS_VISIBLE.
static void	refreshFor(VCSFileProxy[] files) Refreshes all necessary filesystems.
static void	versionedRootsChanged() Helper method to signal that a versioning system started to manage some previously unversioned files (those files were imported into repository).

Methods inherited from class java.lang.Object

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

Field Detail

PREF_BOOLEAN_TEXT_ANNOTATIONS_VISIBLE

public static final String PREF_BOOLEAN_TEXT_ANNOTATIONS_VISIBLE

Boolean property defining visibility of textual versioning annotations (aka Status Labels).

See Also:

VersioningSupport.getPreferences(), Constant Field Values

Method Detail

getPreferences

public static Preferences getPreferences()

Common settings and preferences for versioning modules are set in this preferences node.

Returns:

Preferences node for Versioning modules

See Also:

VersioningSupport.PREF_BOOLEAN_TEXT_ANNOTATIONS_VISIBLE

isTextAnnotationVisible

public static boolean isTextAnnotationVisible()

Returns the value of VersioningSupport.PREF_BOOLEAN_TEXT_ANNOTATIONS_VISIBLE.

See Also:

VersioningSupport.getPreferences()

getOwner

public static VersioningSystem getOwner(VCSFileProxy file)

Queries the Versioning infrastructure for file ownership.

Parameters:

file - a file to examine

Returns:

VersioningSystem a system that owns (manages) the file or null if the file is not versioned

isFlat

public static boolean isFlat(VCSFileProxy file)

Tests whether the given file represents a flat folder (eg a java package), that is a folder that contains only its direct children.

Parameters:

file - a File to test

Returns:

true if the File represents a flat folder (eg a java package), false otherwise

versionedRootsChanged

public static void versionedRootsChanged()

Helper method to signal that a versioning system started to manage some previously unversioned files (those files were imported into repository).

isExcluded

public static boolean isExcluded(VCSFileProxy folder)

Tests whether the given folder is excluded (unversioned) from version control.

• Folders set in versioning.unversionedFolders system property are excluded. Misconfigured automount daemons may try to look for versioning metadata causing hangs and full load.
• Netbeans userdir is excluded by default. To include the userdir set versioning.netbeans.user.versioned system property to true

Versioning systems must NOT scan a folder if this method returns true and should consider it as unversioned.

Parameters:

folder - a folder to query

Returns:

true if the given folder is excluded from version control, false otherwise

See Also:

#105161, #195284

createProcessBuilder

public static ProcessBuilder createProcessBuilder(VCSFileProxy file)

Creates Process builder. All VCS clients should use this process builder instead of java.lang.ProcessBuilder

Parameters:

file -

Returns:

process builder for local or remote environment

refreshFor

public static void refreshFor(VCSFileProxy[] files)

Refreshes all necessary filesystems. Not all instances of FileObject are refreshed but just those that represent passed files and their children recursively.

Parameters:

files -