org.sonar.api.PropertyField Maven / Gradle / Ivy

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Property field.
 *
 * @since 3.3
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface PropertyField {
  /**
   * Unique key within a property. It shouldn't be prefixed.
   * Settings for this field are stored into the database with a composite key
   * {key of parent property}.{key of the set}.{key of this field}
   * eg. sonar.jira.servers.JIRA1.url
   */
  String key();

  /**
   * This name will be displayed on the Settings page. This can be overridden/translated
   * by adding a a value for: field.{key of parent property}.{key of this field}.name in the language bundle.
   */
  String name();

  /**
   * If not empty, this description will be displayed on the Settings page. This can be overridden/translated
   * by adding a a value for: field.{key of parent property}.{key of this field}.description in the language bundle.
   */
  String description() default "";

  /**
   * Indicative size of the field value in characters. This size is not validated, it is merely used by the GUI
   * to size the different input fields of a property set.
   */
  int indicativeSize() default 20;

  PropertyType type() default PropertyType.STRING;

  /**
   * Options for *_LIST types
   */
  String[] options() default {};
}