Package org.instancio.generator.specs.usa

Interface SsnSpec

All Superinterfaces:

GeneratorSpec<String>, NullableGeneratorSpec<String>, SsnGeneratorSpec, ValueSpec<String>

public interface SsnSpec
extends SsnGeneratorSpec, ValueSpec<String>

Spec for generating US Social Security Number (SSN).

Since:

3.1.0

Method Summary

Modifier and Type	Method	Description
SsnSpec	nullable()	Indicates that null value can be generated.
SsnSpec	separator(String separator)	Generates an SSN formatted with the given separator.

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Method Details

separator

SsnSpec separator(String separator)

Description copied from interface: SsnGeneratorSpec

Generates an SSN formatted with the given separator. For example, if the separator is '-', the SSN will be formatted as follows: 111-11-1111.

Specified by:

separator in interface SsnGeneratorSpec

Parameters:

separator - for separating groups of digits, default is null (groups are not separated)

Returns:

spec builder

nullable

SsnSpec nullable()

Description copied from interface: SsnGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<String>

Specified by:

nullable in interface SsnGeneratorSpec

Specified by:

nullable in interface ValueSpec<String>

Returns:

spec builder