com.fitbur.testify.Mock Maven / Gradle / Ivy
/*
* Copyright 2015 Sharmarke Aden.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.fitbur.testify;
import java.lang.annotation.Documented;
import static java.lang.annotation.ElementType.FIELD;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;
/**
* An annotation used on test class fields to inject mocks of the class under
* test's collaborators. Note that if the field is initialized the value of the
* field will be injected into the class under test.
*
* @author saden
*/
@Documented
@Retention(RUNTIME)
@Target({FIELD})
public @interface Mock {
/**
*
* This value represents the index of the collaborator parameter on the
* class under test constructor that will be mocked and injected into the
* test class. By default this value is set to -1 to enable type based auto
* detection. If you wish to not rely on auto detection you can explicitly
* specify the index of the collaborator on the class under test
* constructor.
*
*
* @return the index of the collaborator parameter on the class under test
* constructor.
*/
int index() default -1;
/**
*
* This value represents the name of the collaborator parameter on the class
* under test constructor that will be mocked and injected into the test
* class. By default this value is set to "" to enable type or name based
* auto detection feature. If you do not wish to not rely on auto detection
* you can explicitly specify the name of the collaborator on the class
* under test constructor.
*
*
* Please note that name based auto detection will only work if your code is
* compiled with debug information (javac -parameters).
*
*
* @return the name of the collaborator parameter on the class under test
* constructor.
*/
String name() default "";
}