io.apimatic.core

Class Parameter

java.lang.Object

io.apimatic.core.Parameter

public final class Parameter
extends Object

HTTP parameters consist of a type, a name, and a value. These parameters appear in the header and body of an HTTP request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.Builder

Method Summary

Modifier and Type	Method and Description
String	getKey() Getter for the key.
Map<String,List<String>>	getMultipartHeaders() Getter for the multipartHeaders.
io.apimatic.coreinterfaces.http.request.MutliPartRequestType	getMultiPartRequest() Getter for the MultipartRequestType.
io.apimatic.coreinterfaces.type.functional.Serializer	getMultipartSerializer() Getter for the multipartSerializer.
Object	getValue() Getter for the parameter value.
boolean	shouldEncode() Getter for the shouldEncode.
void	validate() Validate the parameter fields.

Methods inherited from class java.lang.Object

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

Method Detail

getKey

public String getKey()

Getter for the key.

Returns:

the String key.

shouldEncode

public boolean shouldEncode()

Getter for the shouldEncode.

Returns:

the boolean shouldEncode which determines that should encode the template parameter or not.

getValue

public Object getValue()

Getter for the parameter value.

Returns:

the parameter value.

getMultipartSerializer

public io.apimatic.coreinterfaces.type.functional.Serializer getMultipartSerializer()

Getter for the multipartSerializer.

Returns:

the Serializer multipartSerializer.

getMultiPartRequest

public io.apimatic.coreinterfaces.http.request.MutliPartRequestType getMultiPartRequest()

Getter for the MultipartRequestType.

Returns:

the MultiPartRequestType.

getMultipartHeaders

public Map<String,List<String>> getMultipartHeaders()

Getter for the multipartHeaders.

Returns:

the Map of headers.

validate

public void validate()

Validate the parameter fields.