java/sql-dk/src/main/java/info/globalcode/sql/dk/configuration/PropertyDeclaration.java
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/java/sql-dk/src/main/java/info/globalcode/sql/dk/configuration/PropertyDeclaration.java Mon Mar 04 20:15:24 2019 +0100
1.3 @@ -0,0 +1,57 @@
1.4 +/**
1.5 + * SQL-DK
1.6 + * Copyright © 2015 František Kučera (frantovo.cz)
1.7 + *
1.8 + * This program is free software: you can redistribute it and/or modify
1.9 + * it under the terms of the GNU General Public License as published by
1.10 + * the Free Software Foundation, either version 3 of the License, or
1.11 + * (at your option) any later version.
1.12 + *
1.13 + * This program is distributed in the hope that it will be useful,
1.14 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
1.15 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1.16 + * GNU General Public License for more details.
1.17 + *
1.18 + * You should have received a copy of the GNU General Public License
1.19 + * along with this program. If not, see <http://www.gnu.org/licenses/>.
1.20 + */
1.21 +package info.globalcode.sql.dk.configuration;
1.22 +
1.23 +import java.lang.annotation.ElementType;
1.24 +import java.lang.annotation.Repeatable;
1.25 +import java.lang.annotation.Retention;
1.26 +import static java.lang.annotation.RetentionPolicy.RUNTIME;
1.27 +import java.lang.annotation.Target;
1.28 +
1.29 +/**
1.30 + * Declaration of the (formatter) properties – for documentation purposes.
1.31 + *
1.32 + * TODO: automatically inject properties (configured, ad-hoc, default ones) to the formatters
1.33 + *
1.34 + * @author Ing. František Kučera (frantovo.cz)
1.35 + */
1.36 +@Retention(RUNTIME)
1.37 +@Target({ElementType.TYPE})
1.38 +@Repeatable(PropertyDeclarations.class)
1.39 +public @interface PropertyDeclaration {
1.40 +
1.41 + /**
1.42 + * @return name of the property
1.43 + */
1.44 + String name();
1.45 +
1.46 + /**
1.47 + * @return data type of the value: String, numbers, Boolean or Enum
1.48 + */
1.49 + Class type();
1.50 +
1.51 + /**
1.52 + * @return documentation for the users
1.53 + */
1.54 + String description();
1.55 +
1.56 + /**
1.57 + * @return default value of this property
1.58 + */
1.59 + String defaultValue();
1.60 +}