net.morimekta.providence.reflect.contained

Class CServiceMethod

java.lang.Object

net.morimekta.providence.reflect.contained.CServiceMethod

All Implemented Interfaces:

PServiceMethod, CAnnotatedDescriptor

public class CServiceMethod
extends Object
implements PServiceMethod, CAnnotatedDescriptor

Descriptor for a single service method.

Constructor Summary

Constructors

Constructor and Description
CServiceMethod(String comment, String name, boolean oneway, CStructDescriptor requestType, CUnionDescriptor responseType, Map<String,String> annotations)

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.
String	getDocumentation() The type comment is the last block of comment written before the type declaration.
String	getName()
CStructDescriptor	getRequestType()
CUnionDescriptor	getResponseType()
boolean	hasAnnotation(String name) Get the given annotation value.
boolean	isOneway()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.morimekta.providence.reflect.contained.CAnnotatedDescriptor

getAnnotationValue, hasAnnotation

Constructor Detail

CServiceMethod

public CServiceMethod(String comment,
                      String name,
                      boolean oneway,
                      CStructDescriptor requestType,
                      CUnionDescriptor responseType,
                      Map<String,String> annotations)

Method Detail

getName

@Nonnull
public String getName()

Specified by:

getName in interface PServiceMethod

isOneway

public boolean isOneway()

Specified by:

isOneway in interface PServiceMethod

getRequestType

@Nonnull
public CStructDescriptor getRequestType()

Specified by:

getRequestType in interface PServiceMethod

getResponseType

public CUnionDescriptor getResponseType()

Specified by:

getResponseType in interface PServiceMethod

getAnnotations

@Nonnull
public Set<String> getAnnotations()

Description copied from interface: CAnnotatedDescriptor

Get set of available annotations.

Specified by:

getAnnotations in interface CAnnotatedDescriptor

Returns:

The annotation set.

hasAnnotation

public boolean hasAnnotation(@Nonnull
                             String name)

Description copied from interface: CAnnotatedDescriptor

Get the given annotation value.

Specified by:

hasAnnotation in interface CAnnotatedDescriptor

Parameters:

name - Name of annotation.

Returns:

If the annotation is present.

getAnnotationValue

public String getAnnotationValue(@Nonnull
                                 String name)

Description copied from interface: CAnnotatedDescriptor

Get the given annotation value.

Specified by:

getAnnotationValue in interface CAnnotatedDescriptor

Parameters:

name - Name of annotation.

Returns:

The annotation value or null.

getDocumentation

public String getDocumentation()

Description copied from interface: CAnnotatedDescriptor

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

Specified by:

getDocumentation in interface CAnnotatedDescriptor

Returns:

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