net.morimekta.providence.reflect.contained

Interface CAnnotatedDescriptor

All Known Subinterfaces:

CMessageDescriptor

All Known Implementing Classes:

CConst, CEnumDescriptor, CEnumValue, CExceptionDescriptor, CField, CService, CServiceMethod, CStructDescriptor, CUnionDescriptor

public interface CAnnotatedDescriptor

Method Summary

Modifier and Type	Method and Description
Set<String>	getAnnotations() Get set of available annotations.
String	getAnnotationValue(String name) Get the given annotation value.
default String	getAnnotationValue(ThriftAnnotation annotation) Get the given annotation value.
String	getDocumentation() The type comment is the last block of comment written before the type declaration.
boolean	hasAnnotation(String name) Get the given annotation value.
default boolean	hasAnnotation(ThriftAnnotation annotation) Get the given annotation value.

Method Detail

getDocumentation

@Nullable
String getDocumentation()

The type comment is the last block of comment written before the type declaration. Comments on the same line, after the declaration is ignored.

Returns:

The comment string containing all formatting (not including the comment delimiter and the leading space.

getAnnotations

@Nonnull
Set<String> getAnnotations()

Get set of available annotations.

Returns:

The annotation set.

hasAnnotation

boolean hasAnnotation(@Nonnull
                      String name)

Get the given annotation value.

Parameters:

name - Name of annotation.

Returns:

If the annotation is present.

getAnnotationValue

String getAnnotationValue(@Nonnull
                          String name)

Get the given annotation value.

Parameters:

name - Name of annotation.

Returns:

The annotation value or null.

hasAnnotation

default boolean hasAnnotation(@Nonnull
                              ThriftAnnotation annotation)

Get the given annotation value.

Parameters:

annotation - The annotation.

Returns:

If the annotation is present.

getAnnotationValue

default String getAnnotationValue(@Nonnull
                                  ThriftAnnotation annotation)

Get the given annotation value.

Parameters:

annotation - The annotation.

Returns:

The annotation value or null.