DescriptionHelper (SmallRye: GraphQL Common :: Schema Builder 2.0.0.RC4 API)

java.lang.Object
- io.smallrye.graphql.schema.helper.DescriptionHelper

```
public class DescriptionHelper
extends Object
```
Helper to get the correct Description. Basically looking for the @Description annotation.

Author:

Phillip Kruger (phillip.kruger@redhat.com)

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Optional<String>`	`getDescriptionForField(Annotations annotations, org.jboss.jandex.Type type)`	Get the Description on a field or argument
`static Optional<String>`	`getDescriptionForType(Annotations annotations)`	Get the description on a class type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getDescriptionForField
```
public static Optional<String> getDescriptionForField(Annotations annotations,
                                                      org.jboss.jandex.Type type)
```
    Get the Description on a field or argument
    
    Parameters:
    
    annotations - the annotations for that field/argument
    
    type - the java type (some types have default values)
    
    Returns:
    
    the optional description
  - getDescriptionForType
```
public static Optional<String> getDescriptionForType(Annotations annotations)
```
    Get the description on a class type
    
    Parameters:
    
    annotations - annotation on the class
    
    Returns:
    
    the optional description