001/*
002 * Copyright 2023 the original author or authors.
003 * <p>
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * <p>
008 * https://www.apache.org/licenses/LICENSE-2.0
009 * <p>
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package de.cuioss.test.valueobjects.api.generator;
017
018import static java.lang.annotation.ElementType.TYPE;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.io.Serializable;
022import java.lang.annotation.Repeatable;
023import java.lang.annotation.Retention;
024import java.lang.annotation.Target;
025
026import de.cuioss.test.generator.TypedGenerator;
027
028/**
029 * For some cases it is simpler to give a hint for a certain type instead of
030 * declaring {@link PropertyGenerator}. e.g. Your class to be tested needs
031 * instances of certain Interface that need to be {@link Serializable} but this
032 * is not declared at interface level. Therefore this hint may suffice in case
033 * you provide a concrete implementation that can be instantiated. The
034 * test-framework will than always use a {@link TypedGenerator} for all the
035 * tests.
036 *
037 * @author Oliver Wolff
038 */
039@Retention(RUNTIME)
040@Target(TYPE)
041@Repeatable(PropertyGeneratorHints.class)
042public @interface PropertyGeneratorHint {
043
044    /**
045     * @return The type of object that are declared at field and or method /
046     *         constructor level
047     */
048    Class<?> declaredType();
049
050    /**
051     * @return the actual implementation type to be used for the
052     *         {@link #declaredType()}. It should provide a publicly accessible
053     *         constructor
054     */
055    Class<?> implementationType();
056
057}