Package org.instancio.generator.specs.usa

Interface SsnGeneratorSpec

All Superinterfaces:

GeneratorSpec<String>, NullableGeneratorSpec<String>

All Known Subinterfaces:

SsnSpec

public interface SsnGeneratorSpec
extends NullableGeneratorSpec<String>

Spec for generating US Social Security Number (SSN).

Since:

3.1.0

Method Summary

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

Method Details

separator

SsnGeneratorSpec separator(String separator)

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

Parameters:

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

Returns:

spec builder

Since:

3.1.0

nullable

SsnGeneratorSpec nullable()

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<String>

Returns:

spec builder

Since:

3.1.0