SwaggerMethodParser (Java Client Runtime for AutoRest 2.1.1 API)

java.lang.Object
- com.microsoft.rest.v2.SwaggerMethodParser

```
public class SwaggerMethodParser
extends Object
```
This class parses details of a specific Swagger REST API call from a provided Swagger interface method.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`body(Object[] swaggerMethodArguments)` Get the object to be used as the body of the HTTP request.
`String`	`bodyContentType()`
`Type`	`bodyJavaType()` Get the type of the body parameter to this method, if present.
`Context`	`context(Object[] swaggerMethodArguments)` Get the `Context` passed into the proxy method.
`Iterable<com.microsoft.rest.v2.EncodedParameter>`	`encodedQueryParameters(Object[] swaggerMethodArguments)` Get the encoded query parameters that have been added to this value based on the provided method arguments.
`Class<?>`	`exceptionBodyType()` Get the type of body Object that a thrown RestException will contain if the HTTP response's status code is not one of the expected status codes.
`Class<? extends RestException>`	`exceptionType()` Get the type of RestException that will be thrown if the HTTP response's status code is not one of the expected status codes.
`int[]`	`expectedStatusCodes()` Get the HTTP response status codes that are expected when a request is sent out for this Swagger method.
`boolean`	`expectsResponseBody()`
`String`	`fullyQualifiedMethodName()` Get the fully qualified method that was called to invoke this HTTP request.
`Iterable<HttpHeader>`	`headers(Object[] swaggerMethodArguments)` Get the headers that have been added to this value based on the provided method arguments.
`String`	`host(Object[] swaggerMethodArguments)` Get the host to use for HTTP requests for this Swagger method.
`HttpMethod`	`httpMethod()` Get the HTTP method that will be used to complete the Swagger method's request.
`boolean`	`isExpectedResponseStatusCode(int responseStatusCode)` Get whether or not the provided response status code is one of the expected status codes for this Swagger method.
`boolean`	`isExpectedResponseStatusCode(int responseStatusCode, int[] additionalAllowedStatusCodes)` Get whether or not the provided response status code is one of the expected status codes for this Swagger method.
`String`	`path(Object[] methodArguments)` Get the path that will be used to complete the Swagger method's request.
`Type`	`returnType()` Get the return type for the method that this object describes.
`Type`	`returnValueWireType()` Get the type that the return value will be send across the network as.
`String`	`scheme(Object[] swaggerMethodArguments)` Get the scheme to use for HTTP requests for this Swagger method.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - fullyQualifiedMethodName
```
public String fullyQualifiedMethodName()
```
    Get the fully qualified method that was called to invoke this HTTP request.
    
    Returns:
    
    The fully qualified method that was called to invoke this HTTP request.
  - httpMethod
```
public HttpMethod httpMethod()
```
    Get the HTTP method that will be used to complete the Swagger method's request.
    
    Returns:
    
    The HTTP method that will be used to complete the Swagger method's request.
  - expectedStatusCodes
```
public int[] expectedStatusCodes()
```
    Get the HTTP response status codes that are expected when a request is sent out for this Swagger method. If the returned int[] is null, then all status codes less than 400 are allowed.
    
    Returns:
    
    The expected HTTP response status codes for this Swagger method or null if all status codes less than 400 are allowed.
  - scheme
```
public String scheme(Object[] swaggerMethodArguments)
```
    Get the scheme to use for HTTP requests for this Swagger method.
    
    Parameters:
    
    swaggerMethodArguments - The arguments to use for scheme/host substitutions.
    
    Returns:
    
    The final host to use for HTTP requests for this Swagger method.
  - host
```
public String host(Object[] swaggerMethodArguments)
```
    Get the host to use for HTTP requests for this Swagger method.
    
    Parameters:
    
    swaggerMethodArguments - The arguments to use for host substitutions.
    
    Returns:
    
    The final host to use for HTTP requests for this Swagger method.
  - path
```
public String path(Object[] methodArguments)
```
    Get the path that will be used to complete the Swagger method's request.
    
    Parameters:
    
    methodArguments - The method arguments to use with the path substitutions.
    
    Returns:
    
    The path value with its placeholders replaced by the matching substitutions.
  - encodedQueryParameters
```
public Iterable<com.microsoft.rest.v2.EncodedParameter> encodedQueryParameters(Object[] swaggerMethodArguments)
```
    Get the encoded query parameters that have been added to this value based on the provided method arguments.
    
    Parameters:
    
    swaggerMethodArguments - The arguments that will be used to create the query parameters' values.
    
    Returns:
    
    An Iterable with the encoded query parameters.
  - headers
```
public Iterable<HttpHeader> headers(Object[] swaggerMethodArguments)
```
    Get the headers that have been added to this value based on the provided method arguments.
    
    Parameters:
    
    swaggerMethodArguments - The arguments that will be used to create the headers' values.
    
    Returns:
    
    An Iterable with the headers.
  - context
```
public Context context(Object[] swaggerMethodArguments)
```
    Get the Context passed into the proxy method.
    
    Parameters:
    
    swaggerMethodArguments - the arguments passed to the proxy method
    
    Returns:
    
    the Context, or null if no Context was provided
  - isExpectedResponseStatusCode
```
public boolean isExpectedResponseStatusCode(int responseStatusCode)
```
    Get whether or not the provided response status code is one of the expected status codes for this Swagger method.
    
    Parameters:
    
    responseStatusCode - The status code that was returned in the HTTP response.
    
    Returns:
    
    whether or not the provided response status code is one of the expected status codes for this Swagger method.
  - isExpectedResponseStatusCode
```
public boolean isExpectedResponseStatusCode(int responseStatusCode,
                                            int[] additionalAllowedStatusCodes)
```
    Get whether or not the provided response status code is one of the expected status codes for this Swagger method.
    
    Parameters:
    
    responseStatusCode - The status code that was returned in the HTTP response.
    
    additionalAllowedStatusCodes - An additional set of allowed status codes that will be merged with the existing set of allowed status codes for this query.
    
    Returns:
    
    whether or not the provided response status code is one of the expected status codes for this Swagger method.
  - exceptionType
```
public Class<? extends RestException> exceptionType()
```
    Get the type of RestException that will be thrown if the HTTP response's status code is not one of the expected status codes.
    
    Returns:
    
    The type of RestException that will be thrown if the HTTP response's status code is not one of the expected status codes.
  - exceptionBodyType
```
public Class<?> exceptionBodyType()
```
    Get the type of body Object that a thrown RestException will contain if the HTTP response's status code is not one of the expected status codes.
    
    Returns:
    
    The type of body Object that a thrown RestException will contain if the HTTP response's status code is not one of the expected status codes.
  - body
```
public Object body(Object[] swaggerMethodArguments)
```
    Get the object to be used as the body of the HTTP request.
    
    Parameters:
    
    swaggerMethodArguments - The method arguments to get the body object from.
    
    Returns:
    
    The object that will be used as the body of the HTTP request.
  - bodyContentType
```
public String bodyContentType()
```
    Returns:
    
    the Content-Type of the body of this Swagger method.
  - returnType
```
public Type returnType()
```
    Get the return type for the method that this object describes.
    
    Returns:
    
    The return type for the method that this object describes.
  - bodyJavaType
```
public Type bodyJavaType()
```
    Get the type of the body parameter to this method, if present.
    
    Returns:
    
    The return type of the body parameter to this method.
  - returnValueWireType
```
public Type returnValueWireType()
```
    Get the type that the return value will be send across the network as. If returnValueWireType is not null, then the raw HTTP response body will need to parsed to this type and then converted to the actual returnType.
    
    Returns:
    
    The type that the raw HTTP response body will be sent as.
  - expectsResponseBody
```
public boolean expectsResponseBody()
```
    Returns:
    
    Whether or not the Swagger method expects the response to contain a body.

/** 
* Copyright (c) Microsoft Corporation. All rights reserved. 
* Licensed under the MIT License. See License.txt in the project root for 
* license information. 
*/

Class SwaggerMethodParser

Method Summary

Methods inherited from class java.lang.Object

Method Detail

fullyQualifiedMethodName

httpMethod

expectedStatusCodes

scheme

host

path

encodedQueryParameters

headers

context

isExpectedResponseStatusCode

isExpectedResponseStatusCode

exceptionType

exceptionBodyType

body

bodyContentType

returnType

bodyJavaType

returnValueWireType

expectsResponseBody