001/*
002 * Licensed to the author under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package de.cuioss.test.generator.internal.net.java.quickcheck;
018
019/**
020 * Declarative object generator definition.
021 * <p>
022 * User should call implementation of ObjectGenerator as follows:
023 * </p>
024 *
025 * <pre>{@code
026 * ObjectGenerator<T> g;
027 * Generator<R> methodGenerator;
028 * g.on(g.getRecorder().method()).returns(methodGenerator);
029 * }</pre>
030 *
031 * @param <T> type of object generated
032 */
033public interface ObjectGenerator<T> extends Generator<T> {
034
035    /**
036     * Implementation of T that is used to define the method a generator should be
037     * defined for.
038     *
039     * @return an implementation of T used only to record method calls
040     */
041    T getRecorder();
042
043    /**
044     * Define a method a generator should be defined for.
045     *
046     * @param <R>   type of the return type
047     * @param value is ignored
048     * @return {@link ReturnValue} instance to define a generator for this method
049     */
050    <R> ReturnValue<R> on(R value);
051
052    interface ReturnValue<R> {
053
054        void returns(Generator<? extends R> generator);
055    }
056}