org.instancio.InstancioOfCollectionApi Maven / Gradle / Ivy
/*
* Copyright 2022-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.instancio;
/**
* Instancio API for generating collections populated with random data.
*
* @param collection type to create
* @since 2.0.0
*/
public interface InstancioOfCollectionApi extends InstancioApi {
/**
* Specifies collection size to generate.
*
* This method is syntactic sugar for:
*
*
{@code
* List result = Instancio.ofList(Integer.class)
* .generate(root(), gen -> gen.collection().size(50))
* .create();
* }
*
* Therefore, if you modify the collection generator via {@code root()}
* selector (for example, to specify the collection's type) then you will
* need to specify the size using the generator as well.
*
*
For example, instead of:
*
*
{@code
* List result = Instancio.ofList(Integer.class)
* .size(50)
* .generate(root(), gen -> gen.collection().subtype(LinkedList.class))
* .create();
* }
*
* use:
*
*
{@code
* List result = Instancio.ofList(Integer.class)
* .generate(root(), gen -> gen.collection().subtype(LinkedList.class).size(50))
* .create();
* }
*
* @param size of the collection to generate
* @return API builder reference
* @since 2.0.0
*/
InstancioOfCollectionApi size(int size);
}