org.databene.benerator
Interface Generator<E>

All Superinterfaces:

java.io.Closeable, org.databene.commons.Resettable, org.databene.commons.ThreadAware

All Known Implementing Classes:

AbstractArrayGenerator, AbstractBigDecimalGenerator, AbstractBigIntegerGenerator, AbstractGenerator, AbstractNumberGenerator, AbstractSampleGenerator, AcademicTitleGenerator, AccessingGenerator, AddressGenerator, AlternativeGenerator, AsBigDecimalGeneratorWrapper, AsBigIntegerGeneratorWrapper, AsByteGeneratorWrapper, AsDoubleGeneratorWrapper, AsFloatGeneratorWrapper, AsIntegerGeneratorWrapper, AsLongGeneratorWrapper, AsShortGeneratorWrapper, AttachedWeightSampleGenerator, BankAccountGenerator, BankGenerator, BinaryFileContentGenerator, BirthDateGenerator, BitReverseLongGenerator, BitReverseNaturalNumberGenerator, BlankArrayGenerator, BlankEntityGenerator, BooleanGenerator, ByteArrayGenerator, CardinalGenerator, CharacterGenerator, CityGenerator, CNPJGenerator, CollectionGenerator, CompanyDomainGenerator, CompanyNameGenerator, CompositeArrayGenerator, CompositeGenerator, CompositeStringGenerator, ConcatenatingGenerator, ConstantGenerator, ConvertingGenerator, CountryGenerator, CPFGenerator, CreditCardNumberGenerator, CumulatedDoubleGenerator, CumulatedLongGenerator, CumulativeDistributionFunction.IPINumberGenerator, CurrentDateGenerator, CurrentDateTimeGenerator, CurrentMilliTimeGenerator, CurrentNanoTimeGenerator, CurrentTimeGenerator, CyclicGeneratorProxy, DateGenerator, DateTimeGenerator, DayGenerator, DBSeqHiLoGenerator, DBSequenceGenerator, DepartmentNameGenerator, DescriptorBasedGenerator, DigitsGenerator, DistributingGenerator, DistributingSampleGeneratorProxy, DomainGenerator, DynamicCountGenerator, DynamicInstanceArrayGenerator, DynamicLongGenerator, EAN13Generator, EAN8Generator, EANGenerator, EMailAddressGenerator, ExpandGeneratorProxy, ExpressionBasedGenerator, FamilyNameGenerator, FibonacciLongGenerator, FileContentGenerator, FileGenerator, FileNameGenerator, FilteringGenerator, GenderGenerator, GeneratorProxy, GeneratorWrapper, GivenNameGenerator, HibUUIDGenerator, HiLoGenerator, IncrementalIdGenerator, IncrementGenerator, IndividualWeightGenerator, InstanceArrayGenerator, IteratingGenerator, LocalCSVGenerator, LocalSequenceGenerator, LongGenerator, LuhnGenerator, MappedSampleGenerator, MessageGenerator, MobileNumberGenerator, MultiGeneratorWrapper, NobilityTitleGenerator, NounGenerator, NShotGeneratorProxy, OfflineSequenceGenerator, OneShotGenerator, PadovanLongGenerator, PersonGenerator, PhoneNumberGenerator, PredefinedSequenceGenerator, QueryGenerator, QueryHiLoGenerator, QueryLongGenerator, RandomBigDecimalGenerator, RandomBigIntegerGenerator, RandomDomainGenerator, RandomDoubleGenerator, RandomIntegerGenerator, RandomLongGenerator, RandomWalkDoubleGenerator, RandomWalkLongGenerator, RecurrenceRelationNumberGenerator, RegexStringGenerator, RepeatGeneratorProxy, SampleGenerator, ScriptGenerator, SeedGenerator, SeedSentenceGenerator, SeedWordGenerator, SequencedCSVSampleGenerator, SequencedDatasetCSVGenerator, SequenceGenerator, SequenceTableGenerator, ShuffleDoubleGenerator, ShuffleLongGenerator, SimpleArrayGenerator, SimpleCompositeArrayGenerator, SimpleGenerator, SimpleTypeEntityGenerator, SkipGeneratorProxy, SourceAwareGenerator, SSNGenerator, StateGenerator, StateTransitionGenerator, StepDoubleGenerator, StepLongGenerator, StreetNameGenerator, SynchronizedGeneratorProxy, TextFileContentGenerator, ThreadSafeGenerator, TINGenerator, TokenCombiner, TokenCombiner.SimpleTokenCombinator, TopLevelDomainGenerator, UniqueArrayGenerator, UniqueCompositeArrayGenerator, UniqueCompositeStringGenerator, UniqueFixedLengthStringGenerator, UniqueStringGenerator, UUIDGenerator, ValidatingGenerator, ValidatingGeneratorProxy, WebmailDomainGenerator, WedgeDoubleGenerator, WedgeLongGenerator, WeightedCSVSampleGenerator, WeightedDatasetCSVGenerator, WeightedDoubleGenerator, WeightedLongGenerator, WeigthedLiteralGenerator, XMLFileGenerator

public interface Generator<E>
extends org.databene.commons.ThreadAware, org.databene.commons.Resettable, java.io.Closeable

This is the basic Generator interface, the mother of all generators.

Generator States
A Generator may be in one of three states:

• constructing: The generator is under construction. This may take several steps, since generators need to be JavaBeans. The generator may transit into the available state automatically or manually when the validate() method is called.
• available: Generator construction is done and the generator is available. The user may loop the Generator via generate().
• unavailable: The Generator may become unavailable automatically if its value space is depleted or manually when close() has been invoked. The Generator may be made available again by calling reset(). When unavailable, the generator must be in a state in which it can be safely garbage collected.

Developer Notes:
When implementing a custom generator, you should make it a JavaBean:

• Implement a public default (no-arg) constructor
• make each relevant property configurable by a set-method

Created: 07.06.2006 18:51:28

Since:

0.1

Author:

Volker Bergmann

Method Summary

void	close() Closes the generator.
E	generate() Returns an instance of the generic type E.
java.lang.Class<E>	getGeneratedType() Declares the type of the objects returned by the generate() method.
void	init(GeneratorContext context)
boolean	wasInitialized()

Methods inherited from interface org.databene.commons.ThreadAware

isParallelizable, isThreadSafe

Methods inherited from interface org.databene.commons.Resettable

reset

Method Detail

getGeneratedType

java.lang.Class<E> getGeneratedType()

Declares the type of the objects returned by the generate() method.

init

void init(GeneratorContext context)

wasInitialized

boolean wasInitialized()

generate

E generate()

Returns an instance of the generic type E.

close

void close()

Closes the generator. After invocation the state is unavailable.

Specified by:

close in interface java.io.Closeable