From 7fc42d6f103abd0f9febcb43b610ce653f5ce1ab Mon Sep 17 00:00:00 2001 From: arielb Date: Wed, 29 Jun 2016 16:26:13 -0700 Subject: [PATCH] Introducing DoNotMock MOE_MIGRATED_REVID=126245833 --- .../errorprone/annotations/DoNotMock.java | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 annotations/src/main/java/com/google/errorprone/annotations/DoNotMock.java diff --git a/annotations/src/main/java/com/google/errorprone/annotations/DoNotMock.java b/annotations/src/main/java/com/google/errorprone/annotations/DoNotMock.java new file mode 100644 index 00000000000..6b6c86bb33d --- /dev/null +++ b/annotations/src/main/java/com/google/errorprone/annotations/DoNotMock.java @@ -0,0 +1,38 @@ +/* + * Copyright 2016 Google Inc. All Rights Reserved. + * + * 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.google.errorprone.annotations; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target({ + ElementType.TYPE, + ElementType.ANNOTATION_TYPE +}) +public @interface DoNotMock { + /** + * The reason why the annotated type should not be mocked. + * + *

This should suggest alternative APIs to use for testing objects of this type. + */ + String value(); +}