Class MockHttpTransport.Builder

java.lang.Object

com.google.api.client.testing.http.MockHttpTransport.Builder

Enclosing class:

MockHttpTransport

@Beta
public static class MockHttpTransport.Builder
extends Object

Beta
Builder for MockHttpTransport.

Implementation is not thread-safe.

Since:

1.5

Field Summary

Fields

Modifier and Type	Field	Description
(package private) MockLowLevelHttpRequest	lowLevelHttpRequest	The MockLowLevelHttpRequest to be returned by MockHttpTransport.buildRequest(String, String).
(package private) MockLowLevelHttpResponse	lowLevelHttpResponse	The MockLowLevelHttpResponse that should be the result of the MockLowLevelHttpRequest to be returned by MockHttpTransport.buildRequest(String, String).
(package private) Set<String>	supportedMethods	Supported HTTP methods or null to specify that all methods are supported.

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new MockHttpTransport.Builder.

Method Summary

Modifier and Type	Method	Description
MockHttpTransport	build()	Builds a new instance of MockHttpTransport.
final MockLowLevelHttpRequest	getLowLevelHttpRequest()	Returns the MockLowLevelHttpRequest that is associated with this MockHttpTransport.Builder, or null if no such instance exists.
(package private) MockLowLevelHttpResponse	getLowLevelHttpResponse()	Returns the MockLowLevelHttpResponse that is associated with this MockHttpTransport.Builder, or null if no such instance exists.
final Set<String>	getSupportedMethods()	Returns the supported HTTP methods or null to specify that all methods are supported.
final MockHttpTransport.Builder	setLowLevelHttpRequest(MockLowLevelHttpRequest lowLevelHttpRequest)	Sets the MockLowLevelHttpRequest that will be returned by MockHttpTransport.buildRequest(String, String), if non-null.
final MockHttpTransport.Builder	setLowLevelHttpResponse(MockLowLevelHttpResponse lowLevelHttpResponse)	Sets the MockLowLevelHttpResponse that will be the result when the MockLowLevelHttpRequest returned by MockHttpTransport.buildRequest(String, String) is executed.
final MockHttpTransport.Builder	setSupportedMethods(Set<String> supportedMethods)	Sets the supported HTTP methods or null to specify that all methods are supported.

Methods inherited from class Object

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

Field Details

supportedMethods

Set<String> supportedMethods

Supported HTTP methods or null to specify that all methods are supported.

lowLevelHttpRequest

MockLowLevelHttpRequest lowLevelHttpRequest

The MockLowLevelHttpRequest to be returned by MockHttpTransport.buildRequest(String, String). If this field is null, MockHttpTransport.buildRequest(String, String) will create a new instance from its arguments.

lowLevelHttpResponse

MockLowLevelHttpResponse lowLevelHttpResponse

The MockLowLevelHttpResponse that should be the result of the MockLowLevelHttpRequest to be returned by MockHttpTransport.buildRequest(String, String). Note that this field is ignored if the caller provides a MockLowLevelHttpRequest via setLowLevelHttpRequest(MockLowLevelHttpRequest).

Constructor Details

Builder

public Builder()

Constructs a new MockHttpTransport.Builder. Note that this constructor was protected in version 1.17 and its predecessors, and was made public in version 1.18.

Method Details

build

public MockHttpTransport build()

Builds a new instance of MockHttpTransport.

getSupportedMethods

public final Set<String> getSupportedMethods()

Returns the supported HTTP methods or null to specify that all methods are supported.

setSupportedMethods

public final MockHttpTransport.Builder setSupportedMethods(Set<String> supportedMethods)

Sets the supported HTTP methods or null to specify that all methods are supported.

setLowLevelHttpRequest

public final MockHttpTransport.Builder setLowLevelHttpRequest(MockLowLevelHttpRequest lowLevelHttpRequest)

Sets the MockLowLevelHttpRequest that will be returned by MockHttpTransport.buildRequest(String, String), if non-null. If null, MockHttpTransport.buildRequest(String, String) will create a new MockLowLevelHttpRequest arguments.

Note that the user can set a low level HTTP Request only if a low level HTTP response has not been set on this instance.

Since:

1.18

getLowLevelHttpRequest

public final MockLowLevelHttpRequest getLowLevelHttpRequest()

Returns the MockLowLevelHttpRequest that is associated with this MockHttpTransport.Builder, or null if no such instance exists.

Since:

1.18

setLowLevelHttpResponse

public final MockHttpTransport.Builder setLowLevelHttpResponse(MockLowLevelHttpResponse lowLevelHttpResponse)

Sets the MockLowLevelHttpResponse that will be the result when the MockLowLevelHttpRequest returned by MockHttpTransport.buildRequest(String, String) is executed. Note that the response can be set only the caller has not provided a MockLowLevelHttpRequest via setLowLevelHttpRequest(MockLowLevelHttpRequest).

Throws:

IllegalStateException - if the caller has already set a LowLevelHttpRequest in this instance

Since:

1.18

getLowLevelHttpResponse

MockLowLevelHttpResponse getLowLevelHttpResponse()

Returns the MockLowLevelHttpResponse that is associated with this MockHttpTransport.Builder, or null if no such instance exists.

Since:

1.18