/**

 * SQL-DK

 * Copyright © 2015 František Kučera (frantovo.cz)

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 *

 * This program 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program. If not, see <http://www.gnu.org/licenses/>.

 */

package info.globalcode.sql.dk.configuration;

import java.lang.annotation.ElementType;

import java.lang.annotation.Repeatable;

import java.lang.annotation.Retention;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Target;

/**

 * Declaration of the (formatter) properties – for documentation purposes.

 *

 * TODO: automatically inject properties (configured, ad-hoc, default ones) to the formatters

 *

 * @author Ing. František Kučera (frantovo.cz)

 */

@Retention(RUNTIME)

@Target({ElementType.TYPE})

@Repeatable(PropertyDeclarations.class)

public @interface PropertyDeclaration {

	/**

	 * @return name of the property

	 */

	String name();

	/**

	 * @return data type of the value: String, numbers, Boolean or Enum

	 */

	Class type();

	/**

	 * @return documentation for the users

	 */

	String description();

	/**

	 * @return default value of this property

	 */

	String defaultValue();

}