001/* 002 * Copyright 2016 The Error Prone Authors. 003 * 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 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 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 */ 016 017package com.google.errorprone.annotations; 018 019import java.lang.annotation.Documented; 020import java.lang.annotation.ElementType; 021import java.lang.annotation.Inherited; 022import java.lang.annotation.Retention; 023import java.lang.annotation.RetentionPolicy; 024import java.lang.annotation.Target; 025 026/** 027 * Annotation representing a type that should not be mocked. 028 * 029 * <p>When marking a type {@code @DoNotMock}, you should always point to alternative testing 030 * solutions such as standard fakes or other testing utilities. 031 * 032 * <p>Mockito tests can enforce this annotation by using a custom MockMaker which intercepts 033 * creation of mocks. 034 * 035 */ 036@Inherited 037@Documented 038@Retention(RetentionPolicy.SOURCE) 039@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE}) 040public @interface DoNotMock { 041 /** 042 * The reason why the annotated type should not be mocked. 043 * 044 * <p>This should suggest alternative APIs to use for testing objects of this type. 045 */ 046 String value() default "Create a real instance instead"; 047}