Class CommonSectionsFactory

java.lang.Object

com.github.rvesse.airline.help.sections.factories.CommonSectionsFactory

All Implemented Interfaces:

HelpSectionFactory

public class CommonSectionsFactory
extends Object
implements HelpSectionFactory

A help section factory that implements the common sections built into Airline

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<Class<? extends Annotation>>	SUPPORTED

Constructor Summary

Constructors

Constructor	Description
CommonSectionsFactory()

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SUPPORTED

private static final List<Class<? extends Annotation>> SUPPORTED

Constructor Details

CommonSectionsFactory

public CommonSectionsFactory()

Method Details

createSection

public HelpSection createSection(Annotation annotation)

Description copied from interface: HelpSectionFactory

Tries to create a section from the given annotation

Specified by:

createSection in interface HelpSectionFactory

Parameters:

annotation - Annotation

Returns:

Help section or null if the annotation is not supported

supportedAnnotations

public List<Class<? extends Annotation>> supportedAnnotations()

Description copied from interface: HelpSectionFactory

Gets a list of the supported annotations

Specified by:

supportedAnnotations in interface HelpSectionFactory

Returns:

Supported annotations