Class AnnotationUtils
java.lang.Object
com.mrivanplays.annotationconfig.core.utils.AnnotationUtils
A utility class with utilities about AnnotationConfig's default annotations.
- Since:
- 2.1.0
- Author:
- MrIvanPlays
-
Method Summary
Modifier and TypeMethodDescriptiongetComments
(Field field) Returns the comments of the specifiedField
static String
Returns the key of the specifiedField
static boolean
isConfigObject
(Field field) Returns whether the specifiedField
is a config object.static boolean
Returns whether the specifiedField
is ignored upon generation.static boolean
isRawConfigAccess
(Field field) Returns whether the specifiedField
is an accessor of the raw config.
-
Method Details
-
getKey
Returns the key of the specifiedField
- Parameters:
field
- the field you want the key of- Returns:
- the key, always a non-null value
-
isIgnored
Returns whether the specifiedField
is ignored upon generation.- Parameters:
field
- the field you want to check if ignored- Returns:
- true or false
-
isConfigObject
Returns whether the specifiedField
is a config object.- Parameters:
field
- the field you want to check if config object- Returns:
- true or false
-
isRawConfigAccess
Returns whether the specifiedField
is an accessor of the raw config.The raw config in the terminology of AnnotationConfig is the raw values, read from the config.
- Parameters:
field
- the field you want to check if raw config- Returns:
- true or false
-
getComments
Returns the comments of the specifiedField
- Parameters:
field
- the field you want to get the comments of- Returns:
- comments, either an empty list or a list with comments
-