Module com.github.rvesse.airline
Interface HelpSectionFactory
-
- All Known Implementing Classes:
CommonSectionsFactory
,ExternalHelpFactory
,RelatedCommandsFactory
public interface HelpSectionFactory
Interface for factories that convert annotations intoHelpSection
instances
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HelpSection
createSection(java.lang.annotation.Annotation annotation)
Tries to create a section from the given annotationjava.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>>
supportedAnnotations()
Gets a list of the supported annotations
-
-
-
Method Detail
-
createSection
HelpSection createSection(java.lang.annotation.Annotation annotation)
Tries to create a section from the given annotation- Parameters:
annotation
- Annotation- Returns:
- Help section or
null
if the annotation is not supported
-
supportedAnnotations
java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> supportedAnnotations()
Gets a list of the supported annotations- Returns:
- Supported annotations
-
-