org.grpcmock.definitions.stub

Class UnaryMethodStubBuilderImpl<ReqT,RespT>

java.lang.Object

org.grpcmock.definitions.stub.UnaryMethodStubBuilderImpl<ReqT,RespT>

All Implemented Interfaces:

BuilderStep, HeadersMatcherBuilderStep<UnaryMethodStubBuilderStep<ReqT,RespT>>, RequestMatcherBuilderStep<UnaryMethodStubBuilderStep<ReqT,RespT>,ReqT>, MethodStubBuilder<ReqT,RespT>, NextSingleRequestProxyResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>, NextSingleResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>, NextUnaryMethodResponseBuilderStep<ReqT,RespT>, SingleRequestProxyResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>, SingleResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,RespT>, UnaryMethodStubBuilderStep<ReqT,RespT>

public final class UnaryMethodStubBuilderImpl<ReqT,RespT>
extends Object
implements UnaryMethodStubBuilderStep<ReqT,RespT>, NextUnaryMethodResponseBuilderStep<ReqT,RespT>

Author:

Fadelis

Constructor Summary

Constructors

Constructor and Description
UnaryMethodStubBuilderImpl(io.grpc.MethodDescriptor<ReqT,RespT> method)

Method Summary

Modifier and Type	Method and Description
MethodStub<ReqT,RespT>	build()
NextUnaryMethodResponseBuilderStep<ReqT,RespT>	nextWillProxyTo(BiConsumer<ReqT,io.grpc.stub.StreamObserver<RespT>> responseProxy) Defines a proxying response, which will proxy the request to given Response for subsequent request call to this stub.
NextUnaryMethodResponseBuilderStep<ReqT,RespT>	nextWillReturn(ExceptionResponseActionBuilder response) Defines a exception Response for subsequent request call to this stub.
NextUnaryMethodResponseBuilderStep<ReqT,RespT>	nextWillReturn(ObjectResponseActionBuilder<RespT> response) Defines a single Response for subsequent request call to this stub.
NextUnaryMethodResponseBuilderStep<ReqT,RespT>	willProxyTo(BiConsumer<ReqT,io.grpc.stub.StreamObserver<RespT>> responseProxy) Defines a proxying response, which will proxy the request to given Response.
NextUnaryMethodResponseBuilderStep<ReqT,RespT>	willReturn(ExceptionResponseActionBuilder response) Defines a exception Response that will terminate the request.
NextUnaryMethodResponseBuilderStep<ReqT,RespT>	willReturn(ObjectResponseActionBuilder<RespT> response) Defines a single Response that will be returned for the request and complete it.
<T> UnaryMethodStubBuilderStep<ReqT,RespT>	withHeader(io.grpc.Metadata.Key<T> headerKey, Predicate<T> predicate) Adds a header matcher for the stub, which will trigger only if the given header has value satisfying given Predicate.
UnaryMethodStubBuilderStep<ReqT,RespT>	withRequest(Predicate<ReqT> requestPredicate) Adds a request matcher for the stub, which will trigger only if incoming request satisfies given Predicate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.grpcmock.definitions.matcher.steps.HeadersMatcherBuilderStep

withHeader, withHeader, withHeader, withHeader, withoutHeader, withoutHeader

Methods inherited from interface org.grpcmock.definitions.matcher.steps.RequestMatcherBuilderStep

withRequest

Methods inherited from interface org.grpcmock.definitions.stub.steps.SingleResponseBuilderStep

willReturn, willReturn

Methods inherited from interface org.grpcmock.definitions.stub.steps.SingleRequestProxyResponseBuilderStep

willReturn

Methods inherited from interface org.grpcmock.definitions.stub.steps.NextSingleResponseBuilderStep

nextWillReturn, nextWillReturn

Methods inherited from interface org.grpcmock.definitions.stub.steps.NextSingleRequestProxyResponseBuilderStep

nextWillReturn

Constructor Detail

UnaryMethodStubBuilderImpl

public UnaryMethodStubBuilderImpl(@Nonnull
                                  io.grpc.MethodDescriptor<ReqT,RespT> method)

Method Detail

withHeader

public <T> UnaryMethodStubBuilderStep<ReqT,RespT> withHeader(@Nonnull
                                                             io.grpc.Metadata.Key<T> headerKey,
                                                             @Nonnull
                                                             Predicate<T> predicate)

Description copied from interface: HeadersMatcherBuilderStep

Adds a header matcher for the stub, which will trigger only if the given header has value satisfying given Predicate.

Subsequent matchers for the same header will replace the old one.

Specified by:

withHeader in interface HeadersMatcherBuilderStep<UnaryMethodStubBuilderStep<ReqT,RespT>>

withRequest

public UnaryMethodStubBuilderStep<ReqT,RespT> withRequest(@Nonnull
                                                          Predicate<ReqT> requestPredicate)

Description copied from interface: RequestMatcherBuilderStep

Adds a request matcher for the stub, which will trigger only if incoming request satisfies given Predicate.

Only applicable to unary or server streaming methods.

Subsequent request matchers will replace the old one.

Specified by:

withRequest in interface RequestMatcherBuilderStep<UnaryMethodStubBuilderStep<ReqT,RespT>,ReqT>

willReturn

public NextUnaryMethodResponseBuilderStep<ReqT,RespT> willReturn(@Nonnull
                                                                 ObjectResponseActionBuilder<RespT> response)

Description copied from interface: SingleResponseBuilderStep

Defines a single Response that will be returned for the request and complete it.

Specified by:

willReturn in interface SingleResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,RespT>

willReturn

public NextUnaryMethodResponseBuilderStep<ReqT,RespT> willReturn(@Nonnull
                                                                 ExceptionResponseActionBuilder response)

Description copied from interface: SingleResponseBuilderStep

Defines a exception Response that will terminate the request.

Specified by:

willReturn in interface SingleResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,RespT>

nextWillReturn

public NextUnaryMethodResponseBuilderStep<ReqT,RespT> nextWillReturn(@Nonnull
                                                                     ObjectResponseActionBuilder<RespT> response)

Description copied from interface: NextSingleResponseBuilderStep

Defines a single Response for subsequent request call to this stub.

If there are more requests coming in to this stub than responses defined, the last response defined will be returned for those requests.

Specified by:

nextWillReturn in interface NextSingleResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

nextWillReturn

public NextUnaryMethodResponseBuilderStep<ReqT,RespT> nextWillReturn(@Nonnull
                                                                     ExceptionResponseActionBuilder response)

Description copied from interface: NextSingleResponseBuilderStep

Defines a exception Response for subsequent request call to this stub.

If there are more requests coming in to this stub than responses defined, the last response defined will be returned for those requests.

Specified by:

nextWillReturn in interface NextSingleResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

willProxyTo

public NextUnaryMethodResponseBuilderStep<ReqT,RespT> willProxyTo(@Nonnull
                                                                  BiConsumer<ReqT,io.grpc.stub.StreamObserver<RespT>> responseProxy)

Description copied from interface: SingleRequestProxyResponseBuilderStep

Defines a proxying response, which will proxy the request to given Response. The user is responsible that the request is completed correctly.

Should be used when there needs to be more logic in the response method than returning a simple response. For example:

 .willProxyTo((request, responseObserver) -> {
   responseObserver.onNext(responseObject);
   responseObserver.onCompleted();
 });
 

Specified by:

willProxyTo in interface SingleRequestProxyResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

nextWillProxyTo

public NextUnaryMethodResponseBuilderStep<ReqT,RespT> nextWillProxyTo(@Nonnull
                                                                      BiConsumer<ReqT,io.grpc.stub.StreamObserver<RespT>> responseProxy)

Description copied from interface: NextSingleRequestProxyResponseBuilderStep

Defines a proxying response, which will proxy the request to given Response for subsequent request call to this stub. The user is responsible that the request is completed correctly.

Should be used when there needs to be more logic in the response method than returning a simple response. For example:

 .nextWillProxyTo((request, responseObserver) -> {
   responseObserver.onNext(responseObject);
   responseObserver.onCompleted();
 });
 

Specified by:

nextWillProxyTo in interface NextSingleRequestProxyResponseBuilderStep<NextUnaryMethodResponseBuilderStep<ReqT,RespT>,ReqT,RespT>

build

public MethodStub<ReqT,RespT> build()

Specified by:

build in interface MethodStubBuilder<ReqT,RespT>