com.atlassian.fisheye.spi.admin.data

Class GitRepositoryData

java.lang.Object

com.atlassian.fisheye.spi.admin.data.RepositoryData

com.atlassian.fisheye.spi.admin.data.GitRepositoryData

All Implemented Interfaces:

HasAuthenticationData

public class GitRepositoryData
extends RepositoryData
implements HasAuthenticationData

FishEye repository data object for Git repositories.

Only those methods specified to throw NullPointerException do not accept null values to clear the corresponding field.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.fisheye.spi.admin.data.RepositoryData

RepositoryData.Type

Field Summary

Fields inherited from class com.atlassian.fisheye.spi.admin.data.RepositoryData

NAME_REGEX, NAME_REGEX_PATTERN, TIME_INTERVAL_REGEX

Constructor Summary

Constructors

Constructor and Description
GitRepositoryData(java.lang.String name, java.lang.String location) Deprecated. since 4.2.0; use GitRepositoryData(String, String, String) instead
GitRepositoryData(java.lang.String name, java.lang.String displayName, java.lang.String location) See the documentation of RepositoryData.setName(String), RepositoryData.setDisplayName(String) and setLocation(String) for possible exceptions thrown.

Method Summary

Modifier and Type	Method and Description
AuthenticationData	getAuthentication()
java.lang.Integer	getBlockSize()
java.lang.String	getCommandTimeout()
java.lang.String	getLocation()
java.lang.String	getLocationDescription()
java.lang.String	getPath()
java.lang.Integer	getRenameOption()
RepositoryData.Type	getType()
void	setAuthentication(AuthenticationData authenticationData)
void	setBlockSize(java.lang.Integer blockSize)
void	setCommandTimeout(java.lang.String commandTimeout) Controls how long FishEye and Crucible will wait for a git command to complete.
void	setLocation(java.lang.String location)
void	setPath(java.lang.String path)
void	setRenameOption(java.lang.Integer renameOption) Controls how FishEye and Crucible will detect file renames.

Methods inherited from class com.atlassian.fisheye.spi.admin.data.RepositoryData

getDescription, getDisplayName, getEnabled, getName, getParent, isManaged, isObsolete, isStoreDiff, setDescription, setDisplayName, setEnabled, setManaged, setName, setParent, setStoreDiff, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GitRepositoryData

@Deprecated
public GitRepositoryData(java.lang.String name,
                                     java.lang.String location)

Deprecated. since 4.2.0; use GitRepositoryData(String, String, String) instead

GitRepositoryData

public GitRepositoryData(java.lang.String name,
                         java.lang.String displayName,
                         java.lang.String location)

See the documentation of RepositoryData.setName(String), RepositoryData.setDisplayName(String) and setLocation(String) for possible exceptions thrown.

Method Detail

getType

public RepositoryData.Type getType()

Specified by:

getType in class RepositoryData

getLocation

public java.lang.String getLocation()

setLocation

public void setLocation(java.lang.String location)

Throws:

java.lang.NullPointerException - if location is null

java.lang.IllegalArgumentException - if location is blank

getAuthentication

public AuthenticationData getAuthentication()

Specified by:

getAuthentication in interface HasAuthenticationData

setAuthentication

public void setAuthentication(AuthenticationData authenticationData)

Specified by:

setAuthentication in interface HasAuthenticationData

getPath

public java.lang.String getPath()

setPath

public void setPath(java.lang.String path)

Parameters:

path - The path within the Git repository that you wish to have FishEye index.

getBlockSize

public java.lang.Integer getBlockSize()

setBlockSize

public void setBlockSize(java.lang.Integer blockSize)

Parameters:

blockSize - Controls how many commits FishEye will process in one batch.

getCommandTimeout

public java.lang.String getCommandTimeout()

setCommandTimeout

public void setCommandTimeout(java.lang.String commandTimeout)

Controls how long FishEye and Crucible will wait for a git command to complete. E.g., "5 minutes", "1 hour", 2 days". If not set, this will default to "1 hour"

Throws:

java.lang.IllegalArgumentException - if a non-null commandTimeout does not match RepositoryData.TIME_INTERVAL_REGEX

getRenameOption

public java.lang.Integer getRenameOption()

setRenameOption

public void setRenameOption(java.lang.Integer renameOption)

Controls how FishEye and Crucible will detect file renames. 'none' forces no rename detection. 'moves' forces detection of file renames. 'copies' forces detection of renamed files and copied files. 'detailed' forces detection of renamed and copied files but searches more deeply for copied files than the 'copies' options. Because of the deeper searching, this may slow indexing of the repository. Use with caution.

Parameters:

renameOption - a String containing one of the options explained above: 'none', 'moves', 'copies' or 'detailed'

getLocationDescription

public java.lang.String getLocationDescription()

Specified by:

getLocationDescription in class RepositoryData

Returns:

a human-friendly representation of the location of the repository