com.sap.cloud.sdk.datamodel.metadata.generator

Interface ApiUsageMetadata

All Known Implementing Classes:

ODataApiUsageMetadata, RestApiUsageMetadata

@Beta
public interface ApiUsageMetadata

Metadata about API usage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApiUsageMetadata.Invocation Method invocation type.
static interface	ApiUsageMetadata.MethodArgument A method argument.
static class	ApiUsageMetadata.MethodArgumentDynamic A method argument as variable reference.
static class	ApiUsageMetadata.MethodArgumentStatic A method argument as static code.

Method Summary

Modifier and Type	Method and Description
static ApiUsageMetadata.MethodArgument	arg(String code) Convenient method to add static argument code.
static ApiUsageMetadata.MethodArgument	arg(String name, String type) Convenient method to add an argument reference.
List<ApiUsageMetadata.MethodArgument>	getConstructorArguments() Get constructor arguments.
List<ApiUsageMetadata.Invocation>	getMethodInvocations() Get method invocations.
String	getQualifiedServiceClassName() Get fully-qualified service class name.
String	getQualifiedServiceInterfaceName() Get fully-qualified service interface name.
String	getQualifiedServiceMethodResult() Get fully-qualified method result type.
static ApiUsageMetadata.Invocation	method(String name) Convenience method to create a new method invocation.

Method Detail

getConstructorArguments

@Nonnull
List<ApiUsageMetadata.MethodArgument> getConstructorArguments()

Get constructor arguments.

Returns:

A sorted list of constructor arguments.

getMethodInvocations

@Nonnull
List<ApiUsageMetadata.Invocation> getMethodInvocations()

Get method invocations.

Returns:

A sorted list of method invocations.

getQualifiedServiceInterfaceName

@Nonnull
String getQualifiedServiceInterfaceName()

Get fully-qualified service interface name.

Returns:

The service interface name.

getQualifiedServiceClassName

@Nonnull
String getQualifiedServiceClassName()

Get fully-qualified service class name.

Returns:

The service class name.

getQualifiedServiceMethodResult

@Nonnull
String getQualifiedServiceMethodResult()

Get fully-qualified method result type.

Returns:

The method result type.

method

@Nonnull
static ApiUsageMetadata.Invocation method(@Nonnull
                                                   String name)

Convenience method to create a new method invocation.

Parameters:

name - method name

Returns:

A new instance of a method invocation.

arg

@Nonnull
static ApiUsageMetadata.MethodArgument arg(@Nonnull
                                                    String name,
                                                    @Nonnull
                                                    String type)

Convenient method to add an argument reference.

Parameters:

name - argument name

type - argument type, fully qualified type name

Returns:

A new instance with an additional argument

arg

@Nonnull
static ApiUsageMetadata.MethodArgument arg(@Nonnull
                                                    String code)

Convenient method to add static argument code.

Parameters:

code - argument code, e.g. "5" or "\"String\""

Returns:

A new instance with an additional argument