Error.Converter

java.lang.Object

com.jagrosh.jdautilities.doc.standard.Error.Converter

All Implemented Interfaces:: DocConverter<Error>

Enclosing class:: Error

public static class Error.Converter extends Object implements DocConverter<Error>

The DocConverter for the @Error annotation.

Constructor Summary

Constructors

Constructor

Description

Converter()
Method Summary

Modifier and Type

Method

Description

String

read(Error 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 Details
- Converter
  
  public Converter()
Method Details
- read
  
  public String read(Error 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<Error>
  
  Parameters:
  
  annotation - The annotation to process.
  
  Returns:
  
  A String processed from the Annotation provided.