Package sonia.scm.repository.spi
Class BrowseCommandRequest
java.lang.Object
sonia.scm.repository.spi.FileBaseCommandRequest
sonia.scm.repository.spi.BrowseCommandRequest
- All Implemented Interfaces:
Serializable,Cloneable,Resetable
- Since:
- 1.17
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()intgetLimit()Returns the limit for the number of result files.intThe number of the entry, the result start with.booleanReturns whether empty folders are collapsed until a folder has content and return the path to such folder as a single item or not.booleanReturns true if the last commit is disabled.booleanReturns true if the detection of sub repositories is disabled.booleanReturns true if recursive file object browsing is enabled.voidsetCollapse(boolean collapse) Collapse empty folders until a folder has content and return the path to such folder as a single item.voidsetDisableLastCommit(boolean disableLastCommit) True to disable the last commit.voidsetDisableSubRepositoryDetection(boolean disableSubRepositoryDetection) Enable or Disable sub repository detection.voidsetLimit(int limit) Limit the number of result files tolimitentries.voidsetOffset(int offset) Proceed the list from the given number on (zero based).voidsetRecursive(boolean recursive) True to enable recursive file object browsing.voidupdateCache(BrowserResult update) Methods inherited from class sonia.scm.repository.spi.FileBaseCommandRequest
getPath, getRevision, reset, setPath, setRevision
-
Field Details
-
DEFAULT_REQUEST_LIMIT
public static final int DEFAULT_REQUEST_LIMIT- See Also:
-
-
Constructor Details
-
BrowseCommandRequest
public BrowseCommandRequest() -
BrowseCommandRequest
-
-
Method Details
-
clone
- Overrides:
clonein classFileBaseCommandRequest
-
isDisableLastCommit
public boolean isDisableLastCommit()Returns true if the last commit is disabled.- Returns:
- true if the last commit is disabled
- Since:
- 1.26
-
setDisableLastCommit
public void setDisableLastCommit(boolean disableLastCommit) True to disable the last commit.- Parameters:
disableLastCommit- true to disable the last commit- Since:
- 1.26
-
isDisableSubRepositoryDetection
public boolean isDisableSubRepositoryDetection()Returns true if the detection of sub repositories is disabled.- Returns:
- true if sub repository detection is disabled.
- Since:
- 1.26
-
setDisableSubRepositoryDetection
public void setDisableSubRepositoryDetection(boolean disableSubRepositoryDetection) Enable or Disable sub repository detection. Default is enabled.- Parameters:
disableSubRepositoryDetection- true to disable sub repository detection- Since:
- 1.26
-
isRecursive
public boolean isRecursive()Returns true if recursive file object browsing is enabled.- Returns:
- true recursive is enabled
- Since:
- 1.26
-
setRecursive
public void setRecursive(boolean recursive) True to enable recursive file object browsing.- Parameters:
recursive- true to enable recursive browsing- Since:
- 1.26
-
getLimit
public int getLimit()Returns the limit for the number of result files.- Since:
- 2.0.0
-
setLimit
public void setLimit(int limit) Limit the number of result files tolimitentries.- Parameters:
limit- The maximal number of files this request shall return.- Since:
- 2.0.0
-
getOffset
public int getOffset()The number of the entry, the result start with. All preceding entries will be omitted.- Since:
- 2.0.0
-
setOffset
public void setOffset(int offset) Proceed the list from the given number on (zero based).- Parameters:
offset- The number of the entry, the result should start with (zero based). All preceding entries will be omitted.- Since:
- 2.0.0
-
isCollapse
public boolean isCollapse()Returns whether empty folders are collapsed until a folder has content and return the path to such folder as a single item or not.- Returns:
trueif empty folders are collapsed, otherwisefalse- Since:
- 2.30.3
-
setCollapse
public void setCollapse(boolean collapse) Collapse empty folders until a folder has content and return the path to such folder as a single item.- Parameters:
collapse-trueif empty folders should be collapsed, otherwisefalse.- Since:
- 2.30.3
-
updateCache
-