Package org.instancio.internal.generator

Class InternalContainerHint

java.lang.Object

org.instancio.internal.generator.InternalContainerHint

All Implemented Interfaces:

Hint<InternalContainerHint>

@InternalApi
public final class InternalContainerHint
extends Object
implements Hint<InternalContainerHint>

Hint containing details on how to build a container. Container represents a data structure that can be built using static methods.

An example of a container is Optional or the following ImmutableList:

     ImmutableList.<String>builder()
              .add("one")
              .add("tqo")
              .build();
 

Since:

2.0.0

See Also:

• ContainerCreateFunction
• ContainerAddFunction
• ContainerBuildFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	InternalContainerHint.Builder

Method Summary

Modifier and Type	Method	Description
<C> ContainerAddFunction<C>	addFunction()	Returns the function for adding items to the container.
static InternalContainerHint.Builder	builder()
<B, C> ContainerBuildFunction<B,C>	buildFunction()	Returns the function for building the container.
<C> ContainerCreateFunction<C>	createFunction()	Returns the function for instantiating the container.
static InternalContainerHint	empty()	Returns an empty hint containing default values.
int	generateEntries()	Indicates how many entries the engine should generate and add to the container.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.instancio.generator.Hint

type

Method Details

empty

public static InternalContainerHint empty()

Returns an empty hint containing default values.

Returns:

empty hint

Since:

2.0.0

createFunction

public <C> ContainerCreateFunction<C> createFunction()

Returns the function for instantiating the container.

Type Parameters:

C - container type

Returns:

function for instantiating the container

addFunction

public <C> ContainerAddFunction<C> addFunction()

Returns the function for adding items to the container.

Type Parameters:

C - container type

Returns:

function for adding items to the container

buildFunction

public <B,
C> ContainerBuildFunction<B,C> buildFunction()

Returns the function for building the container.

Type Parameters:

B - container's builder type

C - container type

Returns:

function for building the container.

generateEntries

public int generateEntries()

Indicates how many entries the engine should generate and add to the container.

Returns:

number of entries to add

builder

public static InternalContainerHint.Builder builder()