001/* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2012 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * Sonar is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020package org.sonar.check; 021 022import java.lang.annotation.ElementType; 023import java.lang.annotation.Retention; 024import java.lang.annotation.RetentionPolicy; 025import java.lang.annotation.Target; 026 027/** 028 * @since 2.3 029 */ 030@Retention(RetentionPolicy.RUNTIME) 031@Target(ElementType.FIELD) 032public @interface RuleProperty { 033 034 /** 035 * The default key is the field name, read by reflection. Overriding this key can be useful when 036 * obfuscating the code. 037 */ 038 String key() default ""; 039 040 /** 041 * Optional description 042 */ 043 String description() default ""; 044 045 /** 046 * Optional default value. 047 */ 048 String defaultValue() default ""; 049 050 /** 051 * Optional type. 052 * See {@org.sonar.api.PropertyType} for possible values. 053 * If <code>type</code> is ommited, it is guessed from the type of the annotated field. 054 * 055 * @since 3.2 056 */ 057 String type() default ""; 058}