com.jagrosh.jdautilities.doc.standard

Class CommandInfo.Converter

java.lang.Object

com.jagrosh.jdautilities.doc.standard.CommandInfo.Converter

All Implemented Interfaces:

DocConverter<CommandInfo>

Enclosing class:

CommandInfo

public static class CommandInfo.Converter
extends java.lang.Object
implements DocConverter<CommandInfo>

The DocConverter for the @CommandInfo annotation.

Constructor Summary

Constructors

Constructor and Description
Converter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	read(CommandInfo annotation) Returns a String processed from the contents of the provided Annotation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Converter

public Converter()

Method Detail

read

public java.lang.String read(CommandInfo annotation)

Description copied from interface: DocConverter

Returns a String processed from the contents of the provided Annotation.
Should never throw and/or encounter uncaught exceptions.

Specified by:

read in interface DocConverter<CommandInfo>

Parameters:

annotation - The annotation to process.

Returns:

A String processed from the Annotation provided.