io.apimatic.core

Class Parameter.Builder

java.lang.Object

io.apimatic.core.Parameter.Builder

Enclosing class:

Parameter

public static class Parameter.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Parameter	build() this method initiates the Parameter.
Parameter.Builder	isRequired(boolean isRequired) Variable determines either we need to validate the parameter.
Parameter.Builder	key(String key) Setter for the key.
Parameter.Builder	multipartHeaders(String key, String value) Add the multi part headers for the multi part request.
Parameter.Builder	multiPartRequestType(io.apimatic.coreinterfaces.http.request.MutliPartRequestType multiPartRequestType) Setter for the multipPart request type.
Parameter.Builder	multipartSerializer(io.apimatic.coreinterfaces.type.functional.Serializer multipartSerializer) Setter for the multipartSerializer.
Parameter.Builder	shouldEncode(boolean shouldEncode) Setter for the shouldEncode.
Parameter.Builder	value(Object value) Setter for the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

key

public Parameter.Builder key(String key)

Setter for the key.

Parameters:

key - the parameter key.

Returns:

Parameter.Builder.

value

public Parameter.Builder value(Object value)

Setter for the value.

Parameters:

value - the parameter value.

Returns:

Parameter.Builder.

multipartSerializer

public Parameter.Builder multipartSerializer(io.apimatic.coreinterfaces.type.functional.Serializer multipartSerializer)

Setter for the multipartSerializer.

Parameters:

multipartSerializer - if the request is MutliPartRequestType MULTI_PART then configure the multipartSerializer.

Returns:

Parameter.Builder.

isRequired

public Parameter.Builder isRequired(boolean isRequired)

Variable determines either we need to validate the parameter.

Parameters:

isRequired - the parameter is required or not.

Returns:

Parameter.Builder.

shouldEncode

public Parameter.Builder shouldEncode(boolean shouldEncode)

Setter for the shouldEncode.

Parameters:

shouldEncode - the template parameter value shouldEncode or not.

Returns:

Parameter.Builder.

multiPartRequestType

public Parameter.Builder multiPartRequestType(io.apimatic.coreinterfaces.http.request.MutliPartRequestType multiPartRequestType)

Setter for the multipPart request type.

Parameters:

multiPartRequestType - the type of multipart request.

Returns:

Parameter.Builder.

multipartHeaders

public Parameter.Builder multipartHeaders(String key,
                                          String value)

Add the multi part headers for the multi part request.

Parameters:

key - the header key.

value - the header value.

Returns:

Parameter.Builder.

build

public Parameter build()

this method initiates the Parameter.

Returns:

the instance of Parameter.