Home | History | Annotate | Download | only in littlemock
      1 /*
      2  * Copyright 2011 Google Inc.
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *     http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package com.google.testing.littlemock;
     18 
     19 import java.lang.annotation.ElementType;
     20 import java.lang.annotation.Retention;
     21 import java.lang.annotation.RetentionPolicy;
     22 import java.lang.annotation.Target;
     23 
     24 /**
     25  * Used to automatically inject a {@link ArgumentCaptor} object for use in your tests.
     26  *
     27  * <p>Just annotate your capture field on your test as follows:
     28  * <pre>
     29  *   &#64;Captor private ArgumentCaptor&lt;String&gt; mCaptureString;
     30  * </pre>
     31  *
     32  * <p>Then when the {@link LittleMock#initMocks(Object)} method is called (which should be
     33  * done in your setUp() call, or in a test base class) all your capture objects will be
     34  * automatically constructed.
     35  *
     36  * @author hugohudson (at) gmail.com (Hugo Hudson)
     37  */
     38 @Target({ ElementType.FIELD })
     39 @Retention(RetentionPolicy.RUNTIME)
     40 public @interface Captor {
     41 }
     42