Package org.instancio.internal.generator.misc

Class GeneratorDecorator

java.lang.Object
org.instancio.internal.generator.misc.GeneratorDecorator
All Implemented Interfaces:
Generator<Object>, GeneratorSpec<Object>
public final class GeneratorDecorator extends Object implements Generator<Object>

  • Constructor Details

    • GeneratorDecorator

      public GeneratorDecorator(Generator<?> delegate, Hints hints)

  • Method Details

    • decorate

      public static Generator<?> decorate(Generator<?> generator, AfterGenerate afterGenerate)

    • generate

      public Object generate(Random random)
      Description copied from interface: Generator
      Returns a generated value.

      If this method produces random data, the data needs to be generated using the provided Random instance. This ensures generated values are reproducible for a given seed value.

      Specified by:
      generate in interface Generator<Object>
      Parameters:
      random - provider for generating random values
      Returns:
      generated value or null if value is nullable, could not be generated, or generation is delegated to the engine

    • hints

      public Hints hints()
      Description copied from interface: Generator
      Hints provided by the generator to the engine.

      The most important hint for custom generators is AfterGenerate. This hint indicates whether the object created by this generator:

      • should be populated (for example, if it has null fields)
      • can be modified using selectors

      For example, setting the hint to AfterGenerate.POPULATE_NULLS will cause Instancio to populate null fields on the object returned by this generator: 

      
   @Override
   public Hints hints() {
       return Hints.afterGenerate(AfterGenerate.POPULATE_NULLS);
   }

      If the action is not specified, default behaviour will be based on the AfterGenerate value configured in the Settings using the key Keys.AFTER_GENERATE_HINT.

      In addition, the following hints can be provided for populating data structures:

      Specified by:
      hints in interface Generator<Object>
      Returns:
      hints from this generator to the engine
      See Also: