Package org.instancio.internal.generator.net

Class URLGenerator

java.lang.Object

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

org.instancio.internal.generator.net.URLGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<URL>, Generator<URL>, GeneratorSpec<URL>, AsGeneratorSpec<URL>, NullableGeneratorSpec<URL>, URLAsGeneratorSpec, URLGeneratorSpec, URLSpec, ValueSpec<URL>

public class URLGenerator
extends AbstractGenerator<T>
implements URLSpec, URLAsGeneratorSpec

Constructor Summary

Constructors

Constructor	Description
URLGenerator()
URLGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
URLGenerator	file(Generator<String> fileGenerator)	Specifies a generator for the file name.
URLGenerator	host(Generator<String> hostGenerator)	Specifies a generator for the host name.
URLGenerator	nullable()	Indicates that null value can be generated.
URLGenerator	port(int port)	Specifies the port number.
URLGenerator	protocol(String... protocols)	Generate a random protocol from the given choices.
URLGenerator	randomPort()	Specifies that a random port number between 1 and 65535 (inclusive) should be generated.
protected URL	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.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec

asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

URLGenerator

public URLGenerator()

URLGenerator

public URLGenerator(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<URL>

Returns:

spec name if defined, or null otherwise

protocol

public URLGenerator protocol(String... protocols)

Description copied from interface: URLGeneratorSpec

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

Specified by:

protocol in interface URLAsGeneratorSpec

Specified by:

protocol in interface URLGeneratorSpec

Specified by:

protocol in interface URLSpec

Parameters:

protocols - one or more values from which a random protocol will be selected

Returns:

spec builder

port

public URLGenerator port(int port)

Description copied from interface: URLGeneratorSpec

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

Specified by:

port in interface URLAsGeneratorSpec

Specified by:

port in interface URLGeneratorSpec

Specified by:

port in interface URLSpec

Parameters:

port - port number to use

Returns:

spec builder

randomPort

public URLGenerator randomPort()

Description copied from interface: URLGeneratorSpec

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

Specified by:

randomPort in interface URLAsGeneratorSpec

Specified by:

randomPort in interface URLGeneratorSpec

Specified by:

randomPort in interface URLSpec

Returns:

spec builder

host

public URLGenerator host(Generator<String> hostGenerator)

Description copied from interface: URLGeneratorSpec

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

Specified by:

host in interface URLAsGeneratorSpec

Specified by:

host in interface URLGeneratorSpec

Specified by:

host in interface URLSpec

Parameters:

hostGenerator - generator for the host name

Returns:

spec builder

file

public URLGenerator file(Generator<String> fileGenerator)

Description copied from interface: URLGeneratorSpec

Specifies a generator for the file name. If not specified, blank file name will be used.

Specified by:

file in interface URLAsGeneratorSpec

Specified by:

file in interface URLGeneratorSpec

Specified by:

file in interface URLSpec

Parameters:

fileGenerator - generator for the file

Returns:

spec builder

nullable

public URLGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<URL>

Specified by:

nullable in interface URLSpec

Specified by:

nullable in interface ValueSpec<URL>

Overrides:

nullable in class AbstractGenerator<URL>

Returns:

spec builder

tryGenerateNonNull

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

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null