Package org.instancio

Interface PredicateSelector

All Superinterfaces:

ConvertibleToScope, DepthPredicateSelector, DepthSelector, GroupableSelector, LenientSelector, ScopeableSelector, TargetSelector, WithinScope

public interface PredicateSelector
extends DepthSelector, DepthPredicateSelector, ScopeableSelector

A selector for matching targets using predicates.

Since:

1.6.0

See Also:

• Select

Method Summary

Modifier and Type	Method	Description
ScopeableSelector	atDepth(int depth)	Restricts this selector's targets to the specified depth.
ScopeableSelector	atDepth(Predicate<Integer> predicate)	Restricts this selector's targets to a depth that satisfies the given predicate.
Scope	toScope()	Scope representation of a selector.
GroupableSelector	within(Scope... scopes)	Specifies the scope for this selector in order to narrow down its target.

Methods inherited from interface org.instancio.ScopeableSelector

lenient

Method Details

within

@ExperimentalApi
GroupableSelector within(Scope... scopes)

Specifies the scope for this selector in order to narrow down its target.

For example, given the following classes:

 record Phone(String countryCode, String number) {}

 record Person(Phone home, Phone cell) {}
 

setting home and cell phone numbers to different values would require differentiating between two field(Phone::number) selectors. This can be achieved using scopes as follows:

 Scope homePhone = field(Person::home).toScope();
 Scope cellPhone = field(Person::cell).toScope();

 Person person = Instancio.of(Person.class)
     .set(field(Phone::number).within(homePhone), "777-88-99")
     .set(field(Phone::number).within(cellPhone), "123-45-67")
     .create();
 

See Selector Scopes section of the user guide for details.

Specified by:

within in interface ScopeableSelector

Specified by:

within in interface WithinScope

Parameters:

scopes - one or more scopes to apply

Returns:

a selector with the specified scope

Since:

4.1.0

atDepth

ScopeableSelector atDepth(Predicate<Integer> predicate)

Restricts this selector's targets to a depth that satisfies the given predicate.

For example, a predicate atDepth(depth -> depth == 1) will restrict the selector to targets at depth 1 only.

The root object is considered to be at depth 0.

Specified by:

atDepth in interface DepthPredicateSelector

Parameters:

predicate - the predicate specifying the acceptable depth

Returns:

a selector restricted to the specified depth

See Also:

• DepthSelector

atDepth

ScopeableSelector atDepth(int depth)

Restricts this selector's targets to the specified depth. The selector will only apply to targets at the specified depth.

When a selector with atDepth(N) is converted using toScope(), the semantics of the Selector.within(Scope...) method still apply, meaning that the selection applies to targets at depth equal to or greater than N.

The root object is considered to be at depth 0.

Specified by:

atDepth in interface DepthSelector

Parameters:

depth - the depth at which the selector should apply

Returns:

a selector restricted to the specified depth

See Also:

• DepthPredicateSelector

toScope

@ExperimentalApi
Scope toScope()

Scope representation of a selector.

Specified by:

toScope in interface ConvertibleToScope

Returns:

scope

Since:

4.2.0