public interface DataspaceSet
By default, if no include/exclude is provided, the set contains all the opened non-technical branches of the repository. As soon as an exclude restriction is set, an include restriction must also be specified.
It is worth noticing that the order of the declaration of the includes/excludes does not matter.
Modifier and Type | Interface and Description |
---|---|
static class |
DataspaceSet.DataspaceChildrenPolicy
Inclusion policies for the children of a current dataspace in a current subset.
|
static class |
DataspaceSet.DataspaceType
Defines all the types that a dataspace can be.
|
Modifier and Type | Method and Description |
---|---|
void |
excludeDataspacesMatching(HomeKey aHomeKey,
DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)
From the set of dataspaces created thanks to the include methods,
excludes the dataspace matching the given key and
its descendants according to the provided children policy.
|
void |
excludeDataspacesMatching(Pattern aPattern,
DataspaceSet.DataspaceType aType,
DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)
From the set of dataspaces created thanks to the include methods,
excludes the dataspaces matching the specified pattern of the specified type, and
its descendants according to the provided children policy.
|
void |
includeAllDataspaces(DataspaceSet.DataspaceType aType)
Includes all the dataspaces of the specified type.
|
void |
includeDataspacesMatching(HomeKey aHomeKey,
DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)
Includes the dataspace matching the given key and
its descendants according to the provided children policy.
|
void |
includeDataspacesMatching(Pattern aPattern,
DataspaceSet.DataspaceType aType,
DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)
Includes the dataspaces matching the specified pattern of the specified type, and
its descendants according to the provided children policy.
|
void |
setIgnoreDataspacesDefaultExcludes(boolean ignoreDefaultExcludes)
By default, the reserved branches and snapshots are not taken into account by the
includes and excludes.
|
void includeAllDataspaces(DataspaceSet.DataspaceType aType)
Nevertheless, it is still possible to exclude a subset of dataspaces
thanks to the methods excludeDataspacesMatching(HomeKey, DataspaceChildrenPolicy)
or excludeDataspacesMatching(Pattern, DataspaceType, DataspaceChildrenPolicy)
.
Reserved branches and snapshots won't be included until
setIgnoreDataspacesDefaultExcludes(boolean)
is called.
void includeDataspacesMatching(HomeKey aHomeKey, DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)
Nevertheless, it is still possible to exclude a subset of dataspaces
thanks to the methods excludeDataspacesMatching(HomeKey, DataspaceChildrenPolicy)
or excludeDataspacesMatching(Pattern, DataspaceType, DataspaceChildrenPolicy)
.
Reserved branches and snapshots won't be included until
setIgnoreDataspacesDefaultExcludes(boolean)
is called.
aHomeKey
- the home key which will be included.aChildrenPolicy
- the policy that will be applied to the matching dataspaces.void includeDataspacesMatching(Pattern aPattern, DataspaceSet.DataspaceType aType, DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)
Nevertheless, it is still possible to exclude an subset of dataspaces
thanks to the method excludeDataspacesMatching(HomeKey, DataspaceChildrenPolicy)
or excludeDataspacesMatching(Pattern, DataspaceType, DataspaceChildrenPolicy)
.
Reserved branches and snapshots won't be included until
setIgnoreDataspacesDefaultExcludes(boolean)
is called.
aPattern
- the pattern that will be applied.aType
- the type of dataspaces that must match.aChildrenPolicy
- the policy applied to the children.void excludeDataspacesMatching(HomeKey aHomeKey, DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)
aHomeKey
- the home key which will be excluded.aChildrenPolicy
- the policy that will be applied to the matching dataspaces.
Note that if aHomeKey
targets a dataspace, the associated initial
snapshot is not concerned by this exclude children policy.includeDataspacesMatching(HomeKey, DataspaceChildrenPolicy)
,
includeDataspacesMatching(Pattern, DataspaceType, DataspaceChildrenPolicy)
void excludeDataspacesMatching(Pattern aPattern, DataspaceSet.DataspaceType aType, DataspaceSet.DataspaceChildrenPolicy aChildrenPolicy)
aPattern
- the pattern that will be applied.aType
- the type of dataspaces that must match.aChildrenPolicy
- the policy applied to the children.includeDataspacesMatching(HomeKey, DataspaceChildrenPolicy)
,
includeDataspacesMatching(Pattern, DataspaceType, DataspaceChildrenPolicy)
void setIgnoreDataspacesDefaultExcludes(boolean ignoreDefaultExcludes)
ignoreDefaultExcludes
- false
by default. Set to true
so that the reserved
branches and snapshots are no longer excluded.