Class InstancesDiff.InstanceCollection
java.lang.Object
org.apache.sling.discovery.commons.InstancesDiff.InstanceCollection
- Enclosing class:
- InstancesDiff
The
InstanceCollection
collection allows to filter the instances using a set of custom filter
either implementing InstanceFilter
or pre-defined ones.Filters conditions are joined combined together using the logical operator "AND".
-
Method Summary
Modifier and TypeMethodDescription@NotNull InstancesDiff.InstanceCollection
filterWith
(@Nullable InstanceFilter filter) Filter the instances with a customInstanceFilter
filter.@NotNull Collection<InstanceDescription>
get()
Return the collection ofInstanceDescription
instances that have not been filtered out.@NotNull InstancesDiff.InstanceCollection
isInClusterView
(@Nullable ClusterView clusterView) Keep only the instances that are contained in the sameClusterView
cluster view as the one provided.@NotNull InstancesDiff.InstanceCollection
isLeader()
Keep only the leader instances (seeInstanceDescription.isLeader()
.@NotNull InstancesDiff.InstanceCollection
isLocal()
Keep only the local instance (seeInstanceDescription.isLocal()
.@NotNull InstancesDiff.InstanceCollection
isNotInClusterView
(@Nullable ClusterView clusterView) Filter out the instances that are contained in the sameClusterView
cluster view as the one provided.@NotNull InstancesDiff.InstanceCollection
Filter out the leader instances (seeInstanceDescription.isLeader()
.@NotNull InstancesDiff.InstanceCollection
Filter out the local instances (seeInstanceDescription.isLocal()
.
-
Method Details
-
filterWith
@NotNull public @NotNull InstancesDiff.InstanceCollection filterWith(@Nullable @Nullable InstanceFilter filter) Filter the instances with a customInstanceFilter
filter.- Parameters:
filter
- the filter to be applied on the instances- Returns:
this
-
isLocal
Keep only the local instance (seeInstanceDescription.isLocal()
.- Returns:
this
-
isNotLocal
Filter out the local instances (seeInstanceDescription.isLocal()
.- Returns:
this
-
isLeader
Keep only the leader instances (seeInstanceDescription.isLeader()
.- Returns:
this
-
isNotLeader
Filter out the leader instances (seeInstanceDescription.isLeader()
.- Returns:
this
-
isInClusterView
@NotNull public @NotNull InstancesDiff.InstanceCollection isInClusterView(@Nullable @Nullable ClusterView clusterView) Keep only the instances that are contained in the sameClusterView
cluster view as the one provided.The comparison between cluster views is done on the basis of the cluster view identifier. Two cluster views with the same identifier are considered equal.
- Parameters:
clusterView
- the cluster view used to filter the instances- Returns:
this
-
isNotInClusterView
@NotNull public @NotNull InstancesDiff.InstanceCollection isNotInClusterView(@Nullable @Nullable ClusterView clusterView) Filter out the instances that are contained in the sameClusterView
cluster view as the one provided.The comparison between cluster views is done on the basis of the cluster view identifier. Two cluster views with the same identifier are considered equal.
- Parameters:
clusterView
- the cluster view used to filter the instances- Returns:
this
-
get
Return the collection ofInstanceDescription
instances that have not been filtered out.- Returns:
- the filtered collection of instances.
-