Package org.instancio.internal.generator.net

Class URIGenerator

java.lang.Object

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

org.instancio.internal.generator.net.URIGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<URI>, Generator<URI>, GeneratorSpec<URI>, AsGeneratorSpec<URI>, NullableGeneratorSpec<URI>, URIAsGeneratorSpec, URIGeneratorSpec, URISpec, ValueSpec<URI>

public class URIGenerator
extends AbstractGenerator<T>
implements URISpec, URIAsGeneratorSpec

Constructor Summary

Constructors

Constructor	Description
URIGenerator()
URIGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
URIGenerator	fragment(Generator<String> fragmentGenerator)	Specifies a generator for the fragmentGenerator.
URIGenerator	host(Generator<String> hostGenerator)	Specifies a generator for the host name.
URIGenerator	nullable()	Indicates that null value can be generated.
URIGenerator	path(Generator<String> path)	Specifies a generator for the path.
URIGenerator	port(int port)	Specifies the port number.
URIGenerator	query(Generator<String> queryGenerator)	Specifies a generator for the query.
URIGenerator	randomPort()	Specifies that a random port number between 1 and 65535 (inclusive) should be generated.
URIGenerator	scheme(String... schemes)	Generate a random scheme from the given choices.
protected URI	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.
URIGenerator	userInfo(String userInfo)	Specifies username.

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.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec

asString

Methods inherited from interface org.instancio.generator.Generator

init

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

URIGenerator

public URIGenerator()

URIGenerator

public URIGenerator(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<URI>

Returns:

spec name if defined, or null otherwise

scheme

public URIGenerator scheme(String... schemes)

Description copied from interface: URIGeneratorSpec

Generate a random scheme from the given choices. If not specified, the default is HTTP.

Specified by:

scheme in interface URIAsGeneratorSpec

Specified by:

scheme in interface URIGeneratorSpec

Specified by:

scheme in interface URISpec

Parameters:

schemes - one or more values from which a random scheme will be selected

Returns:

spec builder

userInfo

public URIGenerator userInfo(String userInfo)

Description copied from interface: URIGeneratorSpec

Specifies username. If not specified, a null user will be generated.

Specified by:

userInfo in interface URIAsGeneratorSpec

Specified by:

userInfo in interface URIGeneratorSpec

Specified by:

userInfo in interface URISpec

Parameters:

userInfo - username to generate

Returns:

spec builder

host

public URIGenerator host(Generator<String> hostGenerator)

Description copied from interface: URIGeneratorSpec

Specifies a generator for the host name. If not specified, a random host name will be generated.

Specified by:

host in interface URIAsGeneratorSpec

Specified by:

host in interface URIGeneratorSpec

Specified by:

host in interface URISpec

Parameters:

hostGenerator - generator for the host name

Returns:

spec builder

port

public URIGenerator port(int port)

Description copied from interface: URIGeneratorSpec

Specifies the port number. If not specified, default port -1 will be used.

Specified by:

port in interface URIAsGeneratorSpec

Specified by:

port in interface URIGeneratorSpec

Specified by:

port in interface URISpec

Parameters:

port - port number to use

Returns:

spec builder

randomPort

public URIGenerator randomPort()

Description copied from interface: URIGeneratorSpec

Specifies that a random port number between 1 and 65535 (inclusive) should be generated.

Specified by:

randomPort in interface URIAsGeneratorSpec

Specified by:

randomPort in interface URIGeneratorSpec

Specified by:

randomPort in interface URISpec

Returns:

spec builder

path

public URIGenerator path(Generator<String> path)

Description copied from interface: URIGeneratorSpec

Specifies a generator for the path. If not specified, null path will be generated.

Specified by:

path in interface URIAsGeneratorSpec

Specified by:

path in interface URIGeneratorSpec

Specified by:

path in interface URISpec

Parameters:

path - generator for the path

Returns:

spec builder

query

public URIGenerator query(Generator<String> queryGenerator)

Description copied from interface: URIGeneratorSpec

Specifies a generator for the query. If not specified, null query will be generated.

Specified by:

query in interface URIAsGeneratorSpec

Specified by:

query in interface URIGeneratorSpec

Specified by:

query in interface URISpec

Parameters:

queryGenerator - generator for the query

Returns:

spec builder

fragment

public URIGenerator fragment(Generator<String> fragmentGenerator)

Description copied from interface: URIGeneratorSpec

Specifies a generator for the fragmentGenerator. If not specified, null fragmentGenerator will be generated.

Specified by:

fragment in interface URIAsGeneratorSpec

Specified by:

fragment in interface URIGeneratorSpec

Specified by:

fragment in interface URISpec

Parameters:

fragmentGenerator - generator for the fragment

Returns:

spec builder

nullable

public URIGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<URI>

Specified by:

nullable in interface URISpec

Specified by:

nullable in interface ValueSpec<URI>

Overrides:

nullable in class AbstractGenerator<URI>

Returns:

spec builder

tryGenerateNonNull

protected URI 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<URI>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null