org.rvpf.document.version

Interface VersionControl

public interface VersionControl

Version control.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BAD_DOCUMENT_EVENT Bad document event.
static ClassDef	DEFAULT_VERSION_CONTROL_CLASS Default class of version control provider.
static String	DOCUMENT_RESTORED_EVENT Document restored event.
static String	DOCUMENT_UPDATED_EVENT Document updated event.
static String	DOCUMENT_VERSION_PROPERTIES Document version control properties.
static String	GOOD_DOCUMENT_EVENT Good document event.
static String	REPOSITORY_PASSWORD_PROPERTY The user password for connection to the repository.
static String	REPOSITORY_USER_PROPERTY The user identification for connection to the repository.
static String	UPDATE_DOCUMENT_SIGNAL Update document signal.
static String	UPDATE_TRIGGER_PROPERTY The path of a file whose presence will trigger an automatic update on startup.
static String	VERSION_CONTROL_CLASS_PROPERTY The class of the version control provider.
static String	WORKSPACE_PROPERTY The document version control workspace directory.

Method Summary

Modifier and Type	Method and Description
boolean	checkout(String modulePath, File directory, Optional<String> revision) Checkouts a module.
void	dispose() Disposes of the allocated resources.
String	getWorkspaceRevision() Gets the workspace revision.
boolean	selectWorkspace(File directory) Selects the workspace directory.
void	setPassword(Optional<char[]> password) Sets the password for authentication.
void	setUser(String user) Sets the user for identification.
boolean	update(Optional<String> revision) Updates the workspace.

Field Detail

BAD_DOCUMENT_EVENT

static final String BAD_DOCUMENT_EVENT

Bad document event.

See Also:

Constant Field Values

DEFAULT_VERSION_CONTROL_CLASS

static final ClassDef DEFAULT_VERSION_CONTROL_CLASS

Default class of version control provider.

DOCUMENT_RESTORED_EVENT

static final String DOCUMENT_RESTORED_EVENT

Document restored event.

See Also:

Constant Field Values

DOCUMENT_UPDATED_EVENT

static final String DOCUMENT_UPDATED_EVENT

Document updated event.

See Also:

Constant Field Values

DOCUMENT_VERSION_PROPERTIES

static final String DOCUMENT_VERSION_PROPERTIES

Document version control properties.

See Also:

Constant Field Values

GOOD_DOCUMENT_EVENT

static final String GOOD_DOCUMENT_EVENT

Good document event.

See Also:

Constant Field Values

REPOSITORY_PASSWORD_PROPERTY

static final String REPOSITORY_PASSWORD_PROPERTY

The user password for connection to the repository.

See Also:

Constant Field Values

REPOSITORY_USER_PROPERTY

static final String REPOSITORY_USER_PROPERTY

The user identification for connection to the repository.

See Also:

Constant Field Values

UPDATE_DOCUMENT_SIGNAL

static final String UPDATE_DOCUMENT_SIGNAL

Update document signal.

See Also:

Constant Field Values

UPDATE_TRIGGER_PROPERTY

static final String UPDATE_TRIGGER_PROPERTY

The path of a file whose presence will trigger an automatic update on startup.

See Also:

Constant Field Values

VERSION_CONTROL_CLASS_PROPERTY

static final String VERSION_CONTROL_CLASS_PROPERTY

The class of the version control provider.

See Also:

Constant Field Values

WORKSPACE_PROPERTY

static final String WORKSPACE_PROPERTY

The document version control workspace directory.

See Also:

Constant Field Values

Method Detail

checkout

@CheckReturnValue
boolean checkout(@Nonnull
                                    String modulePath,
                                    @Nonnull
                                    File directory,
                                    @Nonnull
                                    Optional<String> revision)

Checkouts a module.

Used by a metadata script.

Parameters:

modulePath - The module path.

directory - The destination directory.

revision - The optional revision to checkout.

Returns:

True on success.

dispose

void dispose()

Disposes of the allocated resources.

getWorkspaceRevision

@Nonnull
 @CheckReturnValue
String getWorkspaceRevision()

Gets the workspace revision.

Returns:

The workspace revision.

selectWorkspace

@CheckReturnValue
boolean selectWorkspace(@Nonnull
                                           File directory)

Selects the workspace directory.

Parameters:

directory - The workspace directory.

Returns:

True on success.

setPassword

void setPassword(@Nonnull
                 Optional<char[]> password)

Sets the password for authentication.

Parameters:

password - The optional password.

setUser

void setUser(@Nonnull
             String user)

Sets the user for identification.

Parameters:

user - The user.

update

@CheckReturnValue
boolean update(@Nonnull
                                  Optional<String> revision)

Updates the workspace.

Parameters:

revision - The optional revision to update to.

Returns:

True on success.