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()
int
getLimit()
Returns the limit for the number of result files.int
The number of the entry, the result start with.boolean
Returns whether empty folders are collapsed until a folder has content and return the path to such folder as a single item or not.boolean
Returns true if the last commit is disabled.boolean
Returns true if the detection of sub repositories is disabled.boolean
Returns true if recursive file object browsing is enabled.void
setCollapse
(boolean collapse) Collapse empty folders until a folder has content and return the path to such folder as a single item.void
setDisableLastCommit
(boolean disableLastCommit) True to disable the last commit.void
setDisableSubRepositoryDetection
(boolean disableSubRepositoryDetection) Enable or Disable sub repository detection.void
setLimit
(int limit) Limit the number of result files tolimit
entries.void
setOffset
(int offset) Proceed the list from the given number on (zero based).void
setRecursive
(boolean recursive) True to enable recursive file object browsing.void
updateCache
(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:
clone
in 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 tolimit
entries.- 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:
true
if 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
-true
if empty folders should be collapsed, otherwisefalse
.- Since:
- 2.30.3
-
updateCache
-