Package com.evolveum.midpoint.prism.path

Class PathSet

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.path.PathSet

All Implemented Interfaces:

Freezable, Serializable, Iterable<ItemPath>, Collection<ItemPath>, Set<ItemPath>

@Experimental
public class PathSet
extends AbstractFreezable
implements Set<ItemPath>, Serializable

A "safe" set of ItemPath - i.e. the one where (e.g.) presence is checked using ItemPath.equivalent(ItemPath), not Object.equals(Object) method. Slower than standard set! Operations are evaluated in `O(n)` time.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PathSet()
PathSet(@NotNull Collection<ItemPath> initialContent)

Method Summary

Modifier and Type	Method	Description
boolean	add(@NotNull ItemPath itemPath)
boolean	addAll(@NotNull Collection<? extends ItemPath> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(@NotNull Collection<?> c)
boolean	containsRelated(@NotNull ItemPath path)	Returns `true` it the set (at least partially) covers given item.
boolean	containsSubpathOrEquivalent(@NotNull ItemPath path)
static PathSet	empty()	Returns immutable empty path set.
@NotNull NameKeyedMap<ItemName,PathSet>	factor()	Factors the path set on the first segment of the paths.
boolean	isEmpty()
@NotNull Iterator<ItemPath>	iterator()
static @NotNull PathSet	of(ItemPath... paths)	Returns immutable PathSet.
protected void	performFreeze()
@NotNull PathSet	remainder(@NotNull ItemPath prefix)	Strips the prefix from a set of paths.
boolean	remove(Object o)
boolean	removeAll(@NotNull Collection<?> c)
boolean	retainAll(@NotNull Collection<?> c)
int	size()
@NotNull Object[]	toArray()
<T> @NotNull T[]	toArray(@NotNull T[] a)
String	toString()

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface com.evolveum.midpoint.prism.Freezable

checkImmutable, checkMutable

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Constructor Details

PathSet

public PathSet()

PathSet

public PathSet(@NotNull
 @NotNull Collection<ItemPath> initialContent)

Method Details

empty

public static PathSet empty()

Returns immutable empty path set.

of

@NotNull
public static @NotNull PathSet of(ItemPath... paths)

Returns immutable PathSet. (The immutability is because of similarity with List.of() and similar methods.)

size

public int size()

Specified by:

size in interface Collection<ItemPath>

Specified by:

size in interface Set<ItemPath>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<ItemPath>

Specified by:

isEmpty in interface Set<ItemPath>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<ItemPath>

Specified by:

contains in interface Set<ItemPath>

containsSubpathOrEquivalent

public boolean containsSubpathOrEquivalent(@NotNull
 @NotNull ItemPath path)

iterator

@NotNull
public @NotNull Iterator<ItemPath> iterator()

Specified by:

iterator in interface Collection<ItemPath>

Specified by:

iterator in interface Iterable<ItemPath>

Specified by:

iterator in interface Set<ItemPath>

toArray

@NotNull
public @NotNull Object[] toArray()

Specified by:

toArray in interface Collection<ItemPath>

Specified by:

toArray in interface Set<ItemPath>

toArray

@NotNull
public <T> @NotNull T[] toArray(@NotNull
 @NotNull T[] a)

Specified by:

toArray in interface Collection<ItemPath>

Specified by:

toArray in interface Set<ItemPath>

add

public boolean add(@NotNull
 @NotNull ItemPath itemPath)

Specified by:

add in interface Collection<ItemPath>

Specified by:

add in interface Set<ItemPath>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<ItemPath>

Specified by:

remove in interface Set<ItemPath>

containsAll

public boolean containsAll(@NotNull
 @NotNull Collection<?> c)

Specified by:

containsAll in interface Collection<ItemPath>

Specified by:

containsAll in interface Set<ItemPath>

addAll

public boolean addAll(@NotNull
 @NotNull Collection<? extends ItemPath> c)

Specified by:

addAll in interface Collection<ItemPath>

Specified by:

addAll in interface Set<ItemPath>

retainAll

public boolean retainAll(@NotNull
 @NotNull Collection<?> c)

Specified by:

retainAll in interface Collection<ItemPath>

Specified by:

retainAll in interface Set<ItemPath>

removeAll

public boolean removeAll(@NotNull
 @NotNull Collection<?> c)

Specified by:

removeAll in interface Collection<ItemPath>

Specified by:

removeAll in interface Set<ItemPath>

clear

public void clear()

Specified by:

clear in interface Collection<ItemPath>

Specified by:

clear in interface Set<ItemPath>

factor

@NotNull
public @NotNull NameKeyedMap<ItemName,PathSet> factor()

Factors the path set on the first segment of the paths. Assumes that each of the paths begins with a name.

remainder

@NotNull
public @NotNull PathSet remainder(@NotNull
 @NotNull ItemPath prefix)

Strips the prefix from a set of paths. Non-matching (unrelated) paths are ignored, i.e. _NOT_ transformed to empty path.

toString

public String toString()

Overrides:

toString in class Object

performFreeze

protected void performFreeze()

Overrides:

performFreeze in class AbstractFreezable

containsRelated

public boolean containsRelated(@NotNull
 @NotNull ItemPath path)

Returns `true` it the set (at least partially) covers given item.