Package org.instancio.internal.generator.domain.hash

Class HashGenerator

java.lang.Object

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

org.instancio.internal.generator.domain.hash.HashGenerator

All Implemented Interfaces:

Generator<String>, GeneratorSpec<String>, AsGeneratorSpec<String>, HashAsGeneratorSpec, HashGeneratorSpec, HashSpec, NullableGeneratorSpec<String>, ValueSpec<String>

public class HashGenerator
extends AbstractGenerator<String>
implements HashSpec, HashAsGeneratorSpec

Constructor Summary

Constructors

Constructor	Description
HashGenerator()
HashGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
HashGenerator	md5()	Specifies that an MD5 hash should be generated.
HashGenerator	nullable()	Indicates that null value can be generated.
HashGenerator	sha1()	Specifies that a SHA-1 hash should be generated.
HashGenerator	sha256()	Specifies that a SHA-256 hash should be generated.
HashGenerator	sha512()	Specifies that a SHA-512 hash should 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.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

HashGenerator

public HashGenerator()

HashGenerator

public HashGenerator(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

md5

public HashGenerator md5()

Description copied from interface: HashGeneratorSpec

Specifies that an MD5 hash should be generated.

Specified by:

md5 in interface HashAsGeneratorSpec

Specified by:

md5 in interface HashGeneratorSpec

Specified by:

md5 in interface HashSpec

Returns:

spec builder

sha1

public HashGenerator sha1()

Description copied from interface: HashGeneratorSpec

Specifies that a SHA-1 hash should be generated.

Specified by:

sha1 in interface HashAsGeneratorSpec

Specified by:

sha1 in interface HashGeneratorSpec

Specified by:

sha1 in interface HashSpec

Returns:

spec builder

sha256

public HashGenerator sha256()

Description copied from interface: HashGeneratorSpec

Specifies that a SHA-256 hash should be generated.

Specified by:

sha256 in interface HashAsGeneratorSpec

Specified by:

sha256 in interface HashGeneratorSpec

Specified by:

sha256 in interface HashSpec

Returns:

spec builder

sha512

public HashGenerator sha512()

Description copied from interface: HashGeneratorSpec

Specifies that a SHA-512 hash should be generated.

Specified by:

sha512 in interface HashAsGeneratorSpec

Specified by:

sha512 in interface HashGeneratorSpec

Specified by:

sha512 in interface HashSpec

Returns:

spec builder

nullable

public HashGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface HashAsGeneratorSpec

Specified by:

nullable in interface HashGeneratorSpec

Specified by:

nullable in interface HashSpec

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