org.instancio.internal.generator.checksum.Mod11Generator

All Implemented Interfaces:: Generator<String>, GeneratorSpec<String>, AsGeneratorSpec<String>, Mod11AsGeneratorSpec, Mod11GeneratorSpec, Mod11Spec, NullableGeneratorSpec<String>, ValueSpec<String>, InternalLengthGeneratorSpec<String>

public class Mod11Generator extends BaseModCheckGenerator implements Mod11AsGeneratorSpec, Mod11Spec

Constructor Summary

Constructors

Constructor

Description

Mod11Generator()

Mod11Generator(GeneratorContext context)
Method Summary

Modifier and Type

Method

Description

String

apiMethod()

Returns the public API method name of the generator spec.

protected int

base()

Mod11Generator

checkDigitIndex(int idx)

The index of the check digit in the input.

protected int

checkPosition()

protected org.instancio.internal.generator.checksum.BaseModCheckGenerator.Direction

direction()

Mod11Generator

direction(org.instancio.internal.generator.checksum.BaseModCheckGenerator.Direction direction)

Mod11Generator

endIndex(int idx)

The end index for calculating the checksum.

protected int

even(int position)

Mod11Generator

leftToRight()

Specifies that the Mod11 checksum must be done from the leftmost to the rightmost digit (default behaviour is right to left).

Mod11Generator

length(int length)

Length of the number to generate (default value is 16).

org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator

length(int min, int max)

Mod11Generator

nullable()

Indicates that null value can be generated.

Mod11Generator

nullable(boolean isNullable)

protected int

odd(int position)

protected int

payloadLength()

protected int

prefixLength()

Mod11Generator

startIndex(int idx)

The start index for calculating the checksum (default value is 0).

protected int

suffixLength()

protected boolean

sumDigits()

Mod11Generator

threshold(int threshold)

The threshold for the Mod11 algorithm multiplier growth, if no value is specified the multiplier will grow indefinitely (default value is Integer.MAX_VALUE).

protected char

treat10As()

protected char

treat11As()

Mod11Generator

treatCheck10As(char treatCheck10As)

The char that represents the check digit when the Mod11 checksum equals 10 (default value is 'X').

Mod11Generator

treatCheck11As(char treatCheck11As)

The char that represents the check digit when the Mod11 checksum equals 11 (default value is '0').

protected String

tryGenerateNonNull(Random random)

Makes the best effort to return a non-null value.

Methods inherited from class org.instancio.internal.generator.checksum.BaseModCheckGenerator
payload

Methods inherited from class org.instancio.internal.generator.AbstractGenerator
generate, getContext, hints, isNullable

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.Generator
init

Methods inherited from interface org.instancio.generator.ValueSpec
get, list, map, stream, toModel

Constructor Details
- Mod11Generator
  
  public Mod11Generator()
- Mod11Generator
  
  public Mod11Generator(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
- length
  
  public Mod11Generator length(int length)
  
  Description copied from interface: Mod11GeneratorSpec
  
  Length of the number to generate (default value is 16).
  
  Specified by:
  
  length in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  length in interface Mod11GeneratorSpec
  
  Specified by:
  
  length in interface Mod11Spec
  
  Parameters:
  
  length - of the number to generate
  
  Returns:
  
  spec builder
- threshold
  
  public Mod11Generator threshold(int threshold)
  
  Description copied from interface: Mod11GeneratorSpec
  
  The threshold for the Mod11 algorithm multiplier growth, if no value is specified the multiplier will grow indefinitely (default value is Integer.MAX_VALUE).
  
  Specified by:
  
  threshold in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  threshold in interface Mod11GeneratorSpec
  
  Specified by:
  
  threshold in interface Mod11Spec
  
  Parameters:
  
  threshold - for the multiplier growth
  
  Returns:
  
  spec builder
- treatCheck10As
  
  public Mod11Generator treatCheck10As(char treatCheck10As)
  
  Description copied from interface: Mod11GeneratorSpec
  
  The char that represents the check digit when the Mod11 checksum equals 10 (default value is 'X').
  
  Specified by:
  
  treatCheck10As in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  treatCheck10As in interface Mod11GeneratorSpec
  
  Specified by:
  
  treatCheck10As in interface Mod11Spec
  
  Parameters:
  
  treatCheck10As - check digit character to use when the checksum is 10
  
  Returns:
  
  spec builder
- treatCheck11As
  
  public Mod11Generator treatCheck11As(char treatCheck11As)
  
  Description copied from interface: Mod11GeneratorSpec
  
  The char that represents the check digit when the Mod11 checksum equals 11 (default value is '0').
  
  Specified by:
  
  treatCheck11As in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  treatCheck11As in interface Mod11GeneratorSpec
  
  Specified by:
  
  treatCheck11As in interface Mod11Spec
  
  Parameters:
  
  treatCheck11As - check digit character to use when the checksum is 11
  
  Returns:
  
  spec builder
- startIndex
  
  public Mod11Generator startIndex(int idx)
  
  Description copied from interface: Mod11GeneratorSpec
  
  The start index for calculating the checksum (default value is 0).
  
  Specified by:
  
  startIndex in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  startIndex in interface Mod11GeneratorSpec
  
  Specified by:
  
  startIndex in interface Mod11Spec
  
  Parameters:
  
  idx - for calculating the checksum (inclusive)
  
  Returns:
  
  spec builder
- endIndex
  
  public Mod11Generator endIndex(int idx)
  
  Description copied from interface: Mod11GeneratorSpec
  
  The end index for calculating the checksum.
  
  Specified by:
  
  endIndex in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  endIndex in interface Mod11GeneratorSpec
  
  Specified by:
  
  endIndex in interface Mod11Spec
  
  Parameters:
  
  idx - for calculating the checksum (inclusive)
  
  Returns:
  
  spec builder
- checkDigitIndex
  
  public Mod11Generator checkDigitIndex(int idx)
  
  Description copied from interface: Mod11GeneratorSpec
  
  The index of the check digit in the input. If not specified, the last digit will be used as the check digit.
  If set, the digit at the specified index is used. If set the following must hold true:
  checkDigitIndex >= 0 && (checkDigitIndex < startIndex || checkDigitIndex >= endIndex).
  
  Specified by:
  
  checkDigitIndex in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  checkDigitIndex in interface Mod11GeneratorSpec
  
  Specified by:
  
  checkDigitIndex in interface Mod11Spec
  
  Parameters:
  
  idx - index of the check digit
  
  Returns:
  
  spec builder
- even
  
  protected int even(int position)
  
  Overrides:
  
  even in class BaseModCheckGenerator
- odd
  
  protected int odd(int position)
  
  Overrides:
  
  odd in class BaseModCheckGenerator
- leftToRight
  
  public Mod11Generator leftToRight()
  
  Description copied from interface: Mod11GeneratorSpec
  Specifies that the Mod11 checksum must be done from the leftmost to the rightmost digit (default behaviour is right to left).
  e.g. Code 12345-?:
  
  Right to left: the sum (5*2 + 4*3 + 3*4 + 2*5 + 1*6) with check digit 5
  
  Left to right: the sum (1*2 + 2*3 + 3*4 + 4*5 + 5*6) with check digit 7
  Specified by:
  
  leftToRight in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  leftToRight in interface Mod11GeneratorSpec
  
  Specified by:
  
  leftToRight in interface Mod11Spec
  
  Returns:
  
  spec builder
- direction
  
  public Mod11Generator direction(org.instancio.internal.generator.checksum.BaseModCheckGenerator.Direction direction)
- nullable
  
  public Mod11Generator nullable()
  
  Description copied from interface: NullableGeneratorSpec
  
  Indicates that null value can be generated.
  
  Specified by:
  
  nullable in interface Mod11AsGeneratorSpec
  
  Specified by:
  
  nullable in interface Mod11GeneratorSpec
  
  Specified by:
  
  nullable in interface Mod11Spec
  
  Specified by:
  
  nullable in interface NullableGeneratorSpec<String>
  
  Specified by:
  
  nullable in interface ValueSpec<String>
  
  Overrides:
  
  nullable in class AbstractGenerator<String>
  
  Returns:
  
  spec builder
- nullable
  
  public Mod11Generator nullable(boolean isNullable)
  
  Overrides:
  
  nullable in class AbstractGenerator<String>
- sumDigits
  
  protected boolean sumDigits()
  
  Overrides:
  
  sumDigits in class BaseModCheckGenerator
- direction
  
  protected org.instancio.internal.generator.checksum.BaseModCheckGenerator.Direction direction()
  
  Overrides:
  
  direction in class BaseModCheckGenerator
- base
  
  protected int base()
  
  Overrides:
  
  base in class BaseModCheckGenerator
- treat10As
  
  protected char treat10As()
  
  Overrides:
  
  treat10As in class BaseModCheckGenerator
- treat11As
  
  protected char treat11As()
  
  Overrides:
  
  treat11As in class BaseModCheckGenerator
- length
  
  public org.instancio.internal.generator.checksum.VariableLengthModCheckGenerator length(int min, int max)
  
  Specified by:
  
  length in interface InternalLengthGeneratorSpec<String>
- 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.
  
  Overrides:
  
  tryGenerateNonNull in class BaseModCheckGenerator
  
  Parameters:
  
  random - for generating the value
  
  Returns:
  
  generated value, either a null or non-null
- prefixLength
  
  protected int prefixLength()
  
  Overrides:
  
  prefixLength in class BaseModCheckGenerator
- payloadLength
  
  protected int payloadLength()
  
  Specified by:
  
  payloadLength in class BaseModCheckGenerator
- checkPosition
  
  protected int checkPosition()
  
  Overrides:
  
  checkPosition in class BaseModCheckGenerator
- suffixLength
  
  protected int suffixLength()
  
  Overrides:
  
  suffixLength in class BaseModCheckGenerator

Class Mod11Generator

Constructor Summary

Method Summary

Methods inherited from class org.instancio.internal.generator.checksum.BaseModCheckGenerator

Methods inherited from class org.instancio.internal.generator.AbstractGenerator

Methods inherited from class java.lang.Object

Methods inherited from interface org.instancio.generator.specs.AsGeneratorSpec

Methods inherited from interface org.instancio.generator.Generator

Methods inherited from interface org.instancio.generator.ValueSpec

Constructor Details

Mod11Generator

Mod11Generator

Method Details

apiMethod

length

threshold

treatCheck10As

treatCheck11As

startIndex

endIndex

checkDigitIndex

even

odd

leftToRight

direction

nullable

nullable

sumDigits

direction

base

treat10As

treat11As

length

tryGenerateNonNull

prefixLength

payloadLength

checkPosition

suffixLength