Skip navigation links

oracle.jdeveloper.vcs.generic
Interface VCSProfile

All Superinterfaces:

Identifiable

public interface VCSProfile

extends Identifiable

This API is not stable and WILL change in the furture.

Field Summary

static java.lang.String	CHANGELIST_CONTEXT_GROUP_CLIPBOARD
static java.lang.String	CHANGELIST_CONTEXT_GROUP_CONFLICTS
static java.lang.String	CHANGELIST_CONTEXT_GROUP_DIFF
static java.lang.String	CHANGELIST_CONTEXT_GROUP_GENERAL
static java.lang.String	CHANGELIST_CONTEXT_GROUP_OPERATIONS
static java.lang.String	CHANGELIST_CONTEXT_GROUP_SELECTNAV
static java.lang.String	DATA_KEY_COMMON_SETTINGS
static java.lang.String	EXCEPTION_HANDLER_ID_DEFAULT
static java.lang.String	HISTORY_PROPERTY_DATE
static java.lang.String	HISTORY_PROPERTY_DESCRIPTION
static java.lang.String	HISTORY_PROPERTY_REVISION
static java.lang.String	ICON_ID_ADD
static java.lang.String	ICON_ID_ADD_ALL
static java.lang.String	ICON_ID_CHECK_IN
static java.lang.String	ICON_ID_CHECK_IN_ALL
static java.lang.String	ICON_ID_COMPARE_PREVIOUS
static java.lang.String	ICON_ID_MERGE
static java.lang.String	ICON_ID_PENDING_CHANGES
static java.lang.String	ICON_ID_SYNCHRONIZE
static java.lang.String	ICON_ID_SYNCHRONIZE_ALL
static java.lang.String	ICON_ID_UNDO_CHECKOUT
static java.lang.String	MENU_ID_COMPARE
static java.lang.String	MENU_ID_CONTEXT_MAIN
static java.lang.String	MENU_ID_CONTEXT_VERSIONING
static java.lang.String	MENU_ID_OPERATIONS
static java.lang.String	MENU_ID_REPLACE
static java.lang.String	MENU_ID_VERSIONING
static java.lang.String	OVERLAY_ICON_ID_ADDED
static java.lang.String	OVERLAY_ICON_ID_CHECKED_IN
static java.lang.String	OVERLAY_ICON_ID_CHECKED_OUT
static java.lang.String	OVERLAY_ICON_ID_CONFLICTS
static java.lang.String	OVERLAY_ICON_ID_IGNORED
static java.lang.String	OVERLAY_ICON_ID_MODIFIED
static java.lang.String	OVERLAY_ICON_ID_NOT_AUTHENTICATED
static java.lang.String	OVERLAY_ICON_ID_REMOVED
static java.lang.String	OVERLAY_ICON_ID_UNADDED
static java.lang.String	OVERLAY_ICON_ID_UNVERSIONED
static java.lang.String	STATUS_FILTER_ID_CANDIDATE
static java.lang.String	STATUS_FILTER_ID_RECOGNIZED
static java.lang.String	STATUS_FILTER_ID_UNRECOGNIZED
static java.lang.String	STATUS_FILTER_ID_UNVERSIONED
static java.lang.String	STATUS_FILTER_ID_VERSIONED
static java.lang.String	STATUS_ID_UNRECOGNIZED
static java.lang.String	URL_FILTER_ID_CONTROL
static java.lang.String	URL_FILTER_ID_DEFAULT

Method Summary

VCSActionInfo	getActionInfo(java.lang.String actionId)
java.lang.String	getChangeListViewID() Gets the identifying string associated with the view containing the ChangeLists declared in the profile.
CheckOutProvider	getCheckOutProvider() Gets the CheckOutProvider declared in the profile.
VCSPropertyMap	getData(java.lang.String key) Gets a VCSPropertyMap containing data declared in the profile mapped to the specified key.
HistoryProperty	getHistoryProperty(java.lang.String id) Gets the HistoryProperty declared in the profile with the specified id.
java.util.logging.Logger	getLogger()
PendingChangesAdapter	getPendingChangesAdapter() Retrieves the PendingChangesAdapter associated with any ChangeList containing view declared by the profile.
java.lang.String	getQualifiedDataKey(java.lang.String key) Gets the fully qualified version of the supplied data key.
ClientSetting	getSettings() Gets the ClientSetting instance associated with the extension represented by this VCSProfile.
VCSStatusCache	getStatusCache()
VCSStatusFilter	getStatusFilter(java.lang.String id)
VCSStatus	getStatusInstance(java.lang.String id)
java.net.URL	getSystemDirectory() Gets the system directory for the vcs extension represented by this VCSProfile.
URLFilter	getURLFilter(java.lang.String filterId) Gets the URLFilter declared in the profile with the specified id.

Methods inherited from interface javax.ide.Identifiable

getID

Field Detail

STATUS_ID_UNRECOGNIZED

static final java.lang.String STATUS_ID_UNRECOGNIZED

See Also:

Constant Field Values

STATUS_FILTER_ID_VERSIONED

static final java.lang.String STATUS_FILTER_ID_VERSIONED

See Also:

Constant Field Values

STATUS_FILTER_ID_UNVERSIONED

static final java.lang.String STATUS_FILTER_ID_UNVERSIONED

See Also:

Constant Field Values

STATUS_FILTER_ID_CANDIDATE

static final java.lang.String STATUS_FILTER_ID_CANDIDATE

See Also:

Constant Field Values

STATUS_FILTER_ID_RECOGNIZED

static final java.lang.String STATUS_FILTER_ID_RECOGNIZED

See Also:

Constant Field Values

STATUS_FILTER_ID_UNRECOGNIZED

static final java.lang.String STATUS_FILTER_ID_UNRECOGNIZED

See Also:

Constant Field Values

MENU_ID_VERSIONING

static final java.lang.String MENU_ID_VERSIONING

See Also:

Constant Field Values

MENU_ID_OPERATIONS

static final java.lang.String MENU_ID_OPERATIONS

See Also:

Constant Field Values

MENU_ID_COMPARE

static final java.lang.String MENU_ID_COMPARE

See Also:

Constant Field Values

MENU_ID_REPLACE

static final java.lang.String MENU_ID_REPLACE

See Also:

Constant Field Values

MENU_ID_CONTEXT_MAIN

static final java.lang.String MENU_ID_CONTEXT_MAIN

See Also:

Constant Field Values

MENU_ID_CONTEXT_VERSIONING

static final java.lang.String MENU_ID_CONTEXT_VERSIONING

See Also:

Constant Field Values

DATA_KEY_COMMON_SETTINGS

static final java.lang.String DATA_KEY_COMMON_SETTINGS

See Also:

Constant Field Values

URL_FILTER_ID_DEFAULT

static final java.lang.String URL_FILTER_ID_DEFAULT

See Also:

Constant Field Values

URL_FILTER_ID_CONTROL

static final java.lang.String URL_FILTER_ID_CONTROL

See Also:

Constant Field Values

ICON_ID_ADD

static final java.lang.String ICON_ID_ADD

See Also:

Constant Field Values

ICON_ID_ADD_ALL

static final java.lang.String ICON_ID_ADD_ALL

See Also:

Constant Field Values

ICON_ID_UNDO_CHECKOUT

static final java.lang.String ICON_ID_UNDO_CHECKOUT

See Also:

Constant Field Values

ICON_ID_COMPARE_PREVIOUS

static final java.lang.String ICON_ID_COMPARE_PREVIOUS

See Also:

Constant Field Values

ICON_ID_MERGE

static final java.lang.String ICON_ID_MERGE

See Also:

Constant Field Values

ICON_ID_SYNCHRONIZE

static final java.lang.String ICON_ID_SYNCHRONIZE

See Also:

Constant Field Values

ICON_ID_SYNCHRONIZE_ALL

static final java.lang.String ICON_ID_SYNCHRONIZE_ALL

See Also:

Constant Field Values

ICON_ID_CHECK_IN

static final java.lang.String ICON_ID_CHECK_IN

See Also:

Constant Field Values

ICON_ID_CHECK_IN_ALL

static final java.lang.String ICON_ID_CHECK_IN_ALL

See Also:

Constant Field Values

ICON_ID_PENDING_CHANGES

static final java.lang.String ICON_ID_PENDING_CHANGES

See Also:

Constant Field Values

OVERLAY_ICON_ID_ADDED

static final java.lang.String OVERLAY_ICON_ID_ADDED

See Also:

Constant Field Values

OVERLAY_ICON_ID_CHECKED_IN

static final java.lang.String OVERLAY_ICON_ID_CHECKED_IN

See Also:

Constant Field Values

OVERLAY_ICON_ID_CHECKED_OUT

static final java.lang.String OVERLAY_ICON_ID_CHECKED_OUT

See Also:

Constant Field Values

OVERLAY_ICON_ID_CONFLICTS

static final java.lang.String OVERLAY_ICON_ID_CONFLICTS

See Also:

Constant Field Values

OVERLAY_ICON_ID_IGNORED

static final java.lang.String OVERLAY_ICON_ID_IGNORED

See Also:

Constant Field Values

OVERLAY_ICON_ID_MODIFIED

static final java.lang.String OVERLAY_ICON_ID_MODIFIED

See Also:

Constant Field Values

OVERLAY_ICON_ID_REMOVED

static final java.lang.String OVERLAY_ICON_ID_REMOVED

See Also:

Constant Field Values

OVERLAY_ICON_ID_UNADDED

static final java.lang.String OVERLAY_ICON_ID_UNADDED

See Also:

Constant Field Values

OVERLAY_ICON_ID_UNVERSIONED

static final java.lang.String OVERLAY_ICON_ID_UNVERSIONED

See Also:

Constant Field Values

OVERLAY_ICON_ID_NOT_AUTHENTICATED

static final java.lang.String OVERLAY_ICON_ID_NOT_AUTHENTICATED

See Also:

Constant Field Values

HISTORY_PROPERTY_DATE

static final java.lang.String HISTORY_PROPERTY_DATE

See Also:

Constant Field Values

HISTORY_PROPERTY_REVISION

static final java.lang.String HISTORY_PROPERTY_REVISION

See Also:

Constant Field Values

HISTORY_PROPERTY_DESCRIPTION

static final java.lang.String HISTORY_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

EXCEPTION_HANDLER_ID_DEFAULT

static final java.lang.String EXCEPTION_HANDLER_ID_DEFAULT

See Also:

Constant Field Values

CHANGELIST_CONTEXT_GROUP_CONFLICTS

static final java.lang.String CHANGELIST_CONTEXT_GROUP_CONFLICTS

See Also:

Constant Field Values

CHANGELIST_CONTEXT_GROUP_OPERATIONS

static final java.lang.String CHANGELIST_CONTEXT_GROUP_OPERATIONS

See Also:

Constant Field Values

CHANGELIST_CONTEXT_GROUP_DIFF

static final java.lang.String CHANGELIST_CONTEXT_GROUP_DIFF

See Also:

Constant Field Values

CHANGELIST_CONTEXT_GROUP_GENERAL

static final java.lang.String CHANGELIST_CONTEXT_GROUP_GENERAL

See Also:

Constant Field Values

CHANGELIST_CONTEXT_GROUP_CLIPBOARD

static final java.lang.String CHANGELIST_CONTEXT_GROUP_CLIPBOARD

See Also:

Constant Field Values

CHANGELIST_CONTEXT_GROUP_SELECTNAV

static final java.lang.String CHANGELIST_CONTEXT_GROUP_SELECTNAV

See Also:

Constant Field Values

Method Detail

getStatusCache

VCSStatusCache getStatusCache()

getStatusInstance

VCSStatus getStatusInstance(java.lang.String id)

getSettings

ClientSetting getSettings()

Gets the ClientSetting instance associated with the extension represented by this VCSProfile.

Returns:

the ClientSetting instance which should be used to persist VCS specific preferences.

getData

VCSPropertyMap getData(java.lang.String key)

Gets a VCSPropertyMap containing data declared in the profile mapped to the specified key. The key supplied here should be identical to the id declared in the profile. Equivalent to calling getSettings().getData(getQualifiedDataKey(key)).

Parameters:

key - the data id as declared in the profile.

Returns:

a VCSPropertyMap containing the appropriate data.

getQualifiedDataKey

java.lang.String getQualifiedDataKey(java.lang.String key)

Gets the fully qualified version of the supplied data key. Qualification is achieved by prefixing with the extension id.

Parameters:

key - the data key as declared in the profile.

Returns:

a fully qualified version of the supplied data key.

getURLFilter

URLFilter getURLFilter(java.lang.String filterId)

Gets the URLFilter declared in the profile with the specified id. Use URL_FILTER_ID_DEFAULT to retrieve the profile's default filter.

Parameters:

filterId - the filter id as declared in the profile.

Returns:

the appropriate URLFilter.

getStatusFilter

VCSStatusFilter getStatusFilter(java.lang.String id)

getActionInfo

VCSActionInfo getActionInfo(java.lang.String actionId)

getSystemDirectory

java.net.URL getSystemDirectory()

Gets the system directory for the vcs extension represented by this VCSProfile. All VCS specific data should be stored in this location.

Returns:

the system directory used for storing VCS specific data.

getLogger

java.util.logging.Logger getLogger()

getCheckOutProvider

CheckOutProvider getCheckOutProvider()

Gets the CheckOutProvider declared in the profile.

Returns:

the CheckOutProvider instance used to perform automatic checkouts in the IDE.

getHistoryProperty

HistoryProperty getHistoryProperty(java.lang.String id)

Gets the HistoryProperty declared in the profile with the specified id. History properties useful to most systems can be accessed using the shared ids HISTORY_PROPERTY_DATE, HISTORY_PROPERTY_REVISION and HISTORY_PROPERTY_DESCRIPTION.

Parameters:

id - the history property id as declared in the profile.

Returns:

the appropriate HistoryProperty, or null if no property exists with the specified id.

getChangeListViewID

java.lang.String getChangeListViewID()

Gets the identifying string associated with the view containing the ChangeLists declared in the profile.

Returns:

the ChangeList view id, or null if no such items were declared by the profile.

getPendingChangesAdapter

PendingChangesAdapter getPendingChangesAdapter()

Retrieves the PendingChangesAdapter associated with any ChangeList containing view declared by the profile.

Returns:

the PendingChangesAdapter instance, or null if no change list containing view exists.

Skip navigation links