HelpSectionFactory

All Known Implementing Classes:: CommonSectionsFactory, ExternalHelpFactory, RelatedCommandsFactory

public interface HelpSectionFactory

Interface for factories that convert annotations into HelpSection instances

Method Summary

Modifier and Type

Method

Description

HelpSection

createSection(Annotation annotation)

Tries to create a section from the given annotation

List<Class<? extends Annotation>>

supportedAnnotations()

Gets a list of the supported annotations

Method Details
- createSection
  
  HelpSection createSection(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
  
  List<Class<? extends Annotation>> supportedAnnotations()
  
  Gets a list of the supported annotations
  
  Returns:
  
  Supported annotations