Package org.instancio.internal.generator.domain.internet

Class Ip4Generator

java.lang.Object

org.instancio.internal.generator.AbstractGenerator<String>

org.instancio.internal.generator.domain.internet.Ip4Generator

All Implemented Interfaces:

Generator<String>, GeneratorSpec<String>, Ip4GeneratorSpec, Ip4Spec, NullableGeneratorSpec<String>, ValueSpec<String>

public class Ip4Generator
extends AbstractGenerator<String>
implements Ip4Spec

Constructor Summary

Constructors

Constructor	Description
Ip4Generator()
Ip4Generator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
Ip4Generator	fromCidr(String cidr)	Generates IPv4 address from CIDR notation, for example: fromCidr("192.168.1.0/24").
Ip4Generator	nullable()	Indicates that null value can be generated.
protected String	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.

Methods inherited from class org.instancio.internal.generator.AbstractGenerator

generate, getContext, hints, isNullable, nullable

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.Generator

init

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

Ip4Generator

public Ip4Generator()

Ip4Generator

public Ip4Generator(GeneratorContext context)

Method Details

apiMethod

public String apiMethod()

Description copied from class: AbstractGenerator

Returns the public API method name of the generator spec. The returned name is used for reporting validation errors.

Specified by:

apiMethod in class AbstractGenerator<String>

Returns:

spec name if defined, or null otherwise

fromCidr

public Ip4Generator fromCidr(String cidr)

Description copied from interface: Ip4GeneratorSpec

Generates IPv4 address from CIDR notation, for example: fromCidr("192.168.1.0/24").

Specified by:

fromCidr in interface Ip4GeneratorSpec

Specified by:

fromCidr in interface Ip4Spec

Parameters:

cidr - CIDR notation from which an IP address will be generated

Returns:

generator spec

nullable

public Ip4Generator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<String>

Specified by:

nullable in interface ValueSpec<String>

Overrides:

nullable in class AbstractGenerator<String>

Returns:

spec builder

tryGenerateNonNull

protected String tryGenerateNonNull(Random random)

Description copied from class: AbstractGenerator

Makes the best effort to return a non-null value. However, in certain cases this method will produce a null.

Specified by:

tryGenerateNonNull in class AbstractGenerator<String>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null