java/sql-dk/src/main/java/info/globalcode/sql/dk/configuration/PropertyDeclaration.java
author František Kučera <franta-hg@frantovo.cz>
Thu, 24 Oct 2019 21:43:08 +0200
branchv_0
changeset 250 aae5009bd0af
parent 238 4a1864c3e867
permissions -rw-r--r--
fix license version: GNU GPLv3
     1 /**
     2  * SQL-DK
     3  * Copyright © 2015 František Kučera (frantovo.cz)
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, version 3 of the License.
     8  *
     9  * This program is distributed in the hope that it will be useful,
    10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  * GNU General Public License for more details.
    13  *
    14  * You should have received a copy of the GNU General Public License
    15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
    16  */
    17 package info.globalcode.sql.dk.configuration;
    18 
    19 import java.lang.annotation.ElementType;
    20 import java.lang.annotation.Repeatable;
    21 import java.lang.annotation.Retention;
    22 import static java.lang.annotation.RetentionPolicy.RUNTIME;
    23 import java.lang.annotation.Target;
    24 
    25 /**
    26  * Declaration of the (formatter) properties – for documentation purposes.
    27  *
    28  * TODO: automatically inject properties (configured, ad-hoc, default ones) to the formatters
    29  *
    30  * @author Ing. František Kučera (frantovo.cz)
    31  */
    32 @Retention(RUNTIME)
    33 @Target({ElementType.TYPE})
    34 @Repeatable(PropertyDeclarations.class)
    35 public @interface PropertyDeclaration {
    36 
    37 	/**
    38 	 * @return name of the property
    39 	 */
    40 	String name();
    41 
    42 	/**
    43 	 * @return data type of the value: String, numbers, Boolean or Enum
    44 	 */
    45 	Class type();
    46 	
    47 	/**
    48 	 * @return documentation for the users
    49 	 */
    50 	String description();
    51 
    52 	/**
    53 	 * @return default value of this property
    54 	 */
    55 	String defaultValue();
    56 }