Package ffx.utilities
Annotation Interface FFXKeyword
@Retention(RUNTIME)
@Documented
@Target({TYPE,FIELD})
@Repeatable(FFXKeywords.class)
public @interface FFXKeyword
The FFXKeyword Annotation should be used to document fields that are set using property files,
keyword files, force field parameter files and the Java property system.
- Author:
- Michael J. Schnieders
-
Required Element Summary
Required ElementsModifier and TypeRequired ElementDescriptionA description of this FFXKeyword.The Keyword Group this FFXKeyword belongs to.The name of this FFXKeyword. -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionClass
<?> The Class used to represent the value of this FFXKeyword.The default value for this FFXKeyword.
-
Element Details
-
name
String nameThe name of this FFXKeyword.- Returns:
- The name of this FFXKeyword.
-
clazz
Class<?> clazzThe Class used to represent the value of this FFXKeyword.The default is an instance of Double, which may be stored as a primitive double.
- Returns:
- The Class used to represent this FFXKeyword.
- Default:
java.lang.Double.class
-
keywordGroup
KeywordGroup keywordGroupThe Keyword Group this FFXKeyword belongs to.- Returns:
- The keyword group for this FFXKeyword.
-
defaultValue
String defaultValueThe default value for this FFXKeyword. If there is no default value, then the field is an empty String.- Returns:
- The default value of this keyword.
- Default:
""
-
description
String descriptionA description of this FFXKeyword.- Returns:
- The description.
-