001/*
002 * ModeShape (http://www.modeshape.org)
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 */
016package org.modeshape.common;
017
018import static java.lang.annotation.ElementType.METHOD;
019import static java.lang.annotation.RetentionPolicy.CLASS;
020import java.lang.annotation.Documented;
021import java.lang.annotation.Retention;
022import java.lang.annotation.Target;
023
024/**
025 * Annotation that can be used to help track that a test is verifying the fix for one or more specific issues. To use, simply
026 * place this annotation on the test method and reference the JIRA issue number:
027 * 
028 * <pre>
029 *    &#064;FixFor("MODE-123")
030 *    &#064;Test
031 *    public void shouldVerifyBehavior() {
032 *     ...
033 *    }
034 * </pre>
035 * <p>
036 * It is also possible to reference multiple JIRA issues if the test is verifying multiple ones:
037 * 
038 * <pre>
039 *    &#064;FixFor({"MODE-123","MODE-456"})
040 *    &#064;Test
041 *    public void shouldVerifyBehavior() {
042 *     ...
043 *    }
044 * </pre>
045 * 
046 * </p>
047 */
048@Documented
049@Retention( CLASS )
050@Target( METHOD )
051public @interface FixFor {
052    /**
053     * The JIRA issue for which this is a fix. For example, "MODE-123".
054     * 
055     * @return the issue
056     */
057    String[] value();
058}