com.atlassian.plugins.rest.doclet.generators.schema

Class Annotations

java.lang.Object

com.atlassian.plugins.rest.doclet.generators.schema.Annotations

public final class Annotations
extends Object

Method Summary

Modifier and Type	Method and Description
static String	getDescription(AnnotatedElement field)
static boolean	isRequired(AnnotatedElement element)
static String	resolveFieldName(AnnotatedElement element, String defaultName)
static boolean	shouldFieldBeIncludedInSchema(AnnotatedElement element, String name, Class<?> modelClass, RestProperty.Scope scope)

Methods inherited from class java.lang.Object

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

Method Detail

shouldFieldBeIncludedInSchema

public static boolean shouldFieldBeIncludedInSchema(AnnotatedElement element,
                                                    String name,
                                                    Class<?> modelClass,
                                                    RestProperty.Scope scope)

resolveFieldName

public static String resolveFieldName(AnnotatedElement element,
                                      String defaultName)

isRequired

public static boolean isRequired(AnnotatedElement element)

getDescription

public static String getDescription(AnnotatedElement field)