Index

A B C E G H I J M P Q R S T U
All Classes and Interfaces|All Packages|Serialized Form

A

addBinaryDataRequestBody(BlockStmt, String) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Adds a BinaryData request body to the HTTP request.

addByteArrayRequestBody(BlockStmt, String) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Adds a byte array request body to the HTTP request.

addByteBufferRequestBody(BlockStmt, String) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Adds a ByteBuffer request body to the HTTP request.

addExceptionBodyMapping(int, HttpRequestContext.ExceptionBodyTypeInfo) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Adds an exception body mapping.

addHeader(String, String) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Adds a header.

addImport(String) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Adds an import to the imports map.

addImport(TypeMirror) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Adds an import to the imports map based on the type mirror.

addParameter(HttpRequestContext.MethodParameter) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Adds a parameter to the method.

addQueryParam(String, String, boolean, boolean, boolean) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Adds a query parameter.

addStaticHeaders(String[]) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the static headers from an array of strings.

addStaticQueryParams(String[]) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the static query parameters from an array of strings.

addStringRequestBody(BlockStmt, String) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Adds a String request body to the HTTP request.

addSubstitution(Substitution) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Adds a substitution.

addValue(String) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.QueryParameter

Adds a value to the query parameter.

AnnotationProcessor - Class in io.clientcore.annotation.processor

Annotation processor that generates client code based on annotated interfaces.

AnnotationProcessor() - Constructor for class io.clientcore.annotation.processor.AnnotationProcessor

Creates a new instance of the AnnotationProcessor.

AnnotationProcessorUtils - Class in io.clientcore.annotation.processor.utils

Utility class for annotation processor.

B

Body(String, TypeMirror, String) - Constructor for class io.clientcore.annotation.processor.models.HttpRequestContext.Body

Constructs a new Body.

buildPath(String, HttpRequestContext) - Static method in class io.clientcore.annotation.processor.utils.PathBuilder

Builds the path of the request URL by replacing the placeholders with the actual values.

C

Client Core Compile-Time Annotation Processor - Search tag in Overview

Section

CodeGenUtils - Class in io.clientcore.annotation.processor.utils

This class contains utility methods for encoding query parameters, quoting header values, and other helpers for code generation.

configureRequestBody(BlockStmt, HttpRequestContext, ProcessingEnvironment) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Configures the request with the body content and content type.

createParameterizedTypeStatement(TypeMirror, BlockStmt) - Static method in class io.clientcore.annotation.processor.utils.AnnotationProcessorUtils

Generates a JavaParser Statement for creating a ParameterizedType for the given return type.

E

encodeQueryParamValue(String) - Static method in class io.clientcore.annotation.processor.utils.CodeGenUtils

Encodes a query parameter value for use in generated code.

ExceptionBodyTypeInfo(TypeMirror, boolean) - Constructor for class io.clientcore.annotation.processor.models.HttpRequestContext.ExceptionBodyTypeInfo

Constructs a new ExceptionBodyTypeInfo.

G

generateExpectedResponseCheck(List<Integer>) - Static method in class io.clientcore.annotation.processor.utils.AnnotationProcessorUtils

Generates a JavaParser Statement for creating response code check for the given expected status codes.

generateResponseHandling(BlockStmt, TypeMirror, HttpRequestContext, boolean) - Static method in class io.clientcore.annotation.processor.utils.ResponseHandler

Handles the generation of the complete response processing flow based on the return type.

getAstType(TypeMirror) - Static method in class io.clientcore.annotation.processor.utils.TypeConverter

Converts a DeclaredType to a ClassOrInterfaceType with type arguments.

getBody() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the body.

getContentType() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.Body

Gets the content type.

getDefaultExceptionBodyType() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the default exception body type.

getEntityType(TypeMirror) - Static method in class io.clientcore.annotation.processor.utils.TypeConverter

Gets the entity type for a given AST type.

getExceptionBodyMappings() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the exception body mappings.

getExpectedStatusCodes() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the expected status codes.

getHeaders() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the headers.

getHost() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the host.

getHost() - Method in class io.clientcore.annotation.processor.models.TemplateInput

Gets the host.

getHttpMethod() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the HTTP method.

getHttpRequestContexts() - Method in class io.clientcore.annotation.processor.models.TemplateInput

Gets the list of HTTP request contexts.

getImports() - Method in class io.clientcore.annotation.processor.models.TemplateInput

Gets the imports map.

getInstance() - Static method in interface io.clientcore.annotation.processor.templating.TemplateProcessor

Returns an instance of the TemplateProcessor.

getMethodName() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the method name.

getMethodReturnType() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the method return type.

getName() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.MethodParameter

Gets the name.

getPackageName() - Method in class io.clientcore.annotation.processor.models.TemplateInput

Gets the package name.

getParameterName() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.Body

Gets the parameter name.

getParameterName() - Method in class io.clientcore.annotation.processor.models.Substitution

Get the placeholder's name.

getParameters() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the list of parameters.

getParameterType() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.Body

Gets the parameter type.

getParameterVariableName() - Method in class io.clientcore.annotation.processor.models.Substitution

Get the variable name that will be used to replace the placeholder in the target URL.

getPath() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the path.

getPrimitiveClass(TypeMirror) - Static method in class io.clientcore.annotation.processor.utils.TypeConverter

Gets the primitive class for a given PrimitiveType.

getQueryParams() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the query parameters.

getReturnValueWireType() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the return value wire type.

getServiceInterfaceFQN() - Method in class io.clientcore.annotation.processor.models.TemplateInput

Gets the fully qualified name of the service interface.

getServiceInterfaceImplShortName() - Method in class io.clientcore.annotation.processor.models.TemplateInput

Gets the short name of the service interface implementation.

getServiceInterfaceShortName() - Method in class io.clientcore.annotation.processor.models.TemplateInput

Gets the short name of the service interface.

getShortTypeName() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.MethodParameter

Gets the short type name.

getSubstitution(String) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets a substitution by parameter name.

getSupportedSourceVersion() - Method in class io.clientcore.annotation.processor.AnnotationProcessor

getTypeMirror() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.ExceptionBodyTypeInfo

Gets the type mirror of the exception body.

getTypeMirror() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.MethodParameter

Gets the type mirror.

getUnexpectedResponseExceptionDetails() - Method in class io.clientcore.annotation.processor.models.TemplateInput

Gets the list of unexpected response exception details.

getUriParameterName() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the variable name that is used when creating the HttpRequest.uri.

getValues() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.QueryParameter

Gets the values of the query parameter.

getVariableElement() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.MethodParameter

Gets the VariableElement that resulted in this HttpRequestContext.MethodParameter to be created.

H

handleRequestBodySerialization(BlockStmt, String) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Handles the serialization of the request body based on the content type.

HttpRequestContext - Class in io.clientcore.annotation.processor.models

Represents the context of an HTTP request, including its configuration, parameters, headers, and other details.

HttpRequestContext() - Constructor for class io.clientcore.annotation.processor.models.HttpRequestContext

Constructs a new HttpRequestContext with default values.

HttpRequestContext.Body - Class in io.clientcore.annotation.processor.models

Represents the body of an HTTP request.

HttpRequestContext.ExceptionBodyTypeInfo - Class in io.clientcore.annotation.processor.models

Represents information about the exception body type used in the HTTP request context.

HttpRequestContext.MethodParameter - Class in io.clientcore.annotation.processor.models

Represents a method parameter.

HttpRequestContext.QueryParameter - Class in io.clientcore.annotation.processor.models

Represents a query parameter.

I

io.clientcore.annotation.processor - package io.clientcore.annotation.processor

Package containing the implementation of the annotation processor.

io.clientcore.annotation.processor.exceptions - package io.clientcore.annotation.processor.exceptions

Package containing exceptions for the annotation processor.

io.clientcore.annotation.processor.models - package io.clientcore.annotation.processor.models

Package containing the models used in the annotation processor.

io.clientcore.annotation.processor.templating - package io.clientcore.annotation.processor.templating

Package containing the implementation of the templating.

io.clientcore.annotation.processor.utils - package io.clientcore.annotation.processor.utils

Package containing utility classes for the annotation processor.

isBinaryDataType(TypeMirror, Elements, Types) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Checks if the given parameter type is BinaryData.

isByteArray(TypeMirror) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Checks if the given parameter type is a byte array.

isByteBufferType(TypeMirror, Elements, Types) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Checks if the given parameter type is a ByteBuffer.

isConvenience() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Gets the boolean to true if the provided method is a default method

isDefaultObject() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.ExceptionBodyTypeInfo

Checks if the type is the default object.

isMultiple() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.QueryParameter

Checks if the query parameter can accept multiple values.

isResponseType(TypeMirror) - Static method in class io.clientcore.annotation.processor.utils.TypeConverter

Checks if the given return type is a Response type.

isStatic() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.QueryParameter

Whether the query parameter is a static value.

isStringType(TypeMirror, Elements, Types) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Checks if the given parameter type is a String.

isTemplateHasHost() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Indicates whether the interface had a host configured.

isUriNextLink() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Checks if the URI is a {nextlink}.

J

JavaParserTemplateProcessor - Class in io.clientcore.annotation.processor.templating

This class generates the implementation of the service interface.

JavaParserTemplateProcessor() - Constructor for class io.clientcore.annotation.processor.templating.JavaParserTemplateProcessor

Initializes a new instance of the JavaParserTemplateProcessor class.

M

MethodParameter(TypeMirror, String, String, VariableElement) - Constructor for class io.clientcore.annotation.processor.models.HttpRequestContext.MethodParameter

Constructs a new MethodParameter.

MissingSubstitutionException - Exception Class in io.clientcore.annotation.processor.exceptions

Exception thrown when a substitution is missing from the template.

MissingSubstitutionException(String) - Constructor for exception class io.clientcore.annotation.processor.exceptions.MissingSubstitutionException

Creates a new instance of the exception.

P

PathBuilder - Class in io.clientcore.annotation.processor.utils

This class is responsible for building the path of the request URL by replacing the placeholders with the actual

process(TemplateInput, ProcessingEnvironment) - Method in class io.clientcore.annotation.processor.templating.JavaParserTemplateProcessor

process(TemplateInput, ProcessingEnvironment) - Method in interface io.clientcore.annotation.processor.templating.TemplateProcessor

Processes the given template input using the provided processing environment.

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class io.clientcore.annotation.processor.AnnotationProcessor

Q

QueryParameter(String, boolean, boolean, boolean) - Constructor for class io.clientcore.annotation.processor.models.HttpRequestContext.QueryParameter

Constructs a new QueryParameter.

QueryParameter(List<String>, boolean, boolean, boolean) - Constructor for class io.clientcore.annotation.processor.models.HttpRequestContext.QueryParameter

Constructs a new QueryParameter with multiple values.

quoteHeaderValue(String) - Static method in class io.clientcore.annotation.processor.utils.CodeGenUtils

Applies the following quoting logic to a header value.

R

RequestBodyHandler - Class in io.clientcore.annotation.processor.utils

Utility class for handling request bodies in HTTP requests.

ResponseHandler - Class in io.clientcore.annotation.processor.utils

Utility class to generate response body mode assignment and response handling based on the response body mode.

S

setBody(HttpRequestContext.Body) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the body.

setContentTypeHeader(BlockStmt, String) - Static method in class io.clientcore.annotation.processor.utils.RequestBodyHandler

Sets the Content-Type header for the HTTP request.

setDefaultExceptionBodyType(TypeMirror) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the default exception body type.

setExpectedStatusCodes(int[]) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the expected status codes.

setHost(String) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the host.

setHost(String) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Sets the host.

setHttpMethod(HttpMethod) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the HTTP method.

setHttpRequestContexts(List<HttpRequestContext>) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Sets the HTTP request contexts.

setIsConvenience(boolean) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the boolean to true if the provided method is a default method

setIsUriNextLink(boolean) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets whether the URI is a {nextlink}.

setMethodName(String) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the method name.

setMethodReturnType(TypeMirror) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the method return type.

setPackageName(String) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Sets the package name.

setPath(String) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the path.

setReturnValueWireType(TypeMirror) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets the return value wire type.

setServiceInterfaceFQN(String) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Sets the fully qualified name of the service interface.

setServiceInterfaceImplShortName(String) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Sets the short name of the service interface implementation.

setServiceInterfaceShortName(String) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Sets the short name of the service interface.

setTemplateHasHost(boolean) - Method in class io.clientcore.annotation.processor.models.HttpRequestContext

Sets whether the interface had a host configured.

setUnexpectedResponseExceptionDetails(List<UnexpectedResponseExceptionDetail>) - Method in class io.clientcore.annotation.processor.models.TemplateInput

Sets the list of unexpected response exception details.

shouldEncode() - Method in class io.clientcore.annotation.processor.models.HttpRequestContext.QueryParameter

Checks if the query parameter and value should be encoded.

shouldEncode() - Method in class io.clientcore.annotation.processor.models.Substitution

Whether the replacement value from the method argument needs to be encoded when the substitution is taking place.

Substitution - Class in io.clientcore.annotation.processor.models

A Substitution is a value that can be used to replace placeholder values in a URL.

Substitution(String, String) - Constructor for class io.clientcore.annotation.processor.models.Substitution

Create a new Substitution.

Substitution(String, String, boolean) - Constructor for class io.clientcore.annotation.processor.models.Substitution

Create a new Substitution.

T

TemplateInput - Class in io.clientcore.annotation.processor.models

Represents the input required for generating a template.

TemplateInput() - Constructor for class io.clientcore.annotation.processor.models.TemplateInput

Initializes a new instance of the TemplateInput class.

TemplateProcessor - Interface in io.clientcore.annotation.processor.templating

Interface for processing templates.

toJavaArrayInitializer(List<String>, boolean) - Static method in class io.clientcore.annotation.processor.utils.CodeGenUtils

Joins a list of values into a Java code array initializer.

toReflectType(TypeMirror) - Static method in class io.clientcore.annotation.processor.utils.TypeConverter

Converts JavaParser's AST Type to java.lang.reflect.Type.

TypeConverter - Class in io.clientcore.annotation.processor.utils

Utility class for converting JavaParser AST types to Java reflection types.

U

Usage - Search tag in Overview

Section

A B C E G H I J M P Q R S T U
All Classes and Interfaces|All Packages|Serialized Form