Interface MockPolicyInterceptionSettings

All Known Implementing Classes:
MockPolicyInterceptionSettingsImpl
public interface MockPolicyInterceptionSettings
Contains interception related settings. PowerMock uses the information stored in this object to intercept method calls and field calls etc and specify a return value or suppression.

Since mock policies can be chained subsequent policies can override behavior of a previous policy. To avoid accidental overrides it's recommended add behavior instead of setting behavior since the latter overrides all previous configurations.

  • Method Details

    • setMethodsToSuppress

      void setMethodsToSuppress(Method[] methods)
      Set which methods to suppress. Note that this overrides all previous configurations.

    • addMethodsToSuppress

      void addMethodsToSuppress(Method methodToSuppress, Method... additionalMethodsToSuppress)
      Add methods to suppress upon invocation.

    • addMethodsToSuppress

      void addMethodsToSuppress(Method[] methods)
      Add methods to suppress upon invocation.

    • setMethodsToStub

      void setMethodsToStub(Map<Method,Object> substituteReturnValues)
      Set the substitute return values. The substitute return values is a key-value map where each key is a method that should be intercepted and each value is the new return value for that method when it's intercepted.

      Note that this overrides all previous configurations.

    • stubMethod

      void stubMethod(Method method, Object returnObject)
      Add a method that should be intercepted and return another value ( returnObject) (i.e. the method is stubbed).

    • proxyMethod

      void proxyMethod(Method method, InvocationHandler invocationHandler)
      Proxy a method with the given invocation handler. Each call to the method will be routed to the invocationHandler instead.

    • getProxiedMethods

      Map<Method, InvocationHandler> getProxiedMethods()
      Get all methods that should be proxied and the invocation handler for each method.

    • setMethodsToProxy

      void setMethodsToProxy(Map<Method, InvocationHandler> proxies)
      Set the methods to proxy. The proxies are a key-value map where each key is a method that should be intercepted and routed to the invocation handler instead.

      Note that this overrides all previous configurations.

    • setSubtituteReturnValues

      @Deprecated void setSubtituteReturnValues(Map<Method,Object> substituteReturnValues)
      Deprecated.
      Use stubMethod(Method, Object) instead.
      Set the substitute return values. The substitute return values is a key-value map where each key is a method that should be intercepted and each value is the new return value for that method when it's intercepted.

      Note that this overrides all previous configurations.

    • addSubtituteReturnValue

      @Deprecated void addSubtituteReturnValue(Method method, Object returnObject)
      Deprecated.
      Use stubMethod(Method, Object) instead.
      Add a method that should be intercepted and return another value ( returnObject). The substitute return values is a key-value map where each key is a method that should be intercepted and each value is the new return value for that method when it's intercepted.

    • setFieldsSuppress

      void setFieldsSuppress(Field[] fields)
      Set specific fields that should be suppressed upon invocation. Note that this overrides all previous configurations.

    • addFieldToSuppress

      void addFieldToSuppress(Field firstField, Field... additionalFields)
      Add specific fields that should be suppressed upon invocation.

    • addFieldToSuppress

      void addFieldToSuppress(Field[] fields)
      Add specific fields that should be suppressed upon invocation.

    • setFieldTypesToSuppress

      void setFieldTypesToSuppress(String[] fieldTypes)
      Set which field types that should be suppressed. Note that this overrides all previous configurations.

    • addFieldTypesToSuppress

      void addFieldTypesToSuppress(String firstType, String... additionalFieldTypes)
      Add field types that should be suppressed.

    • addFieldTypesToSuppress

      void addFieldTypesToSuppress(String[] fieldTypes)
      Add field types that should be suppressed.

    • getMethodsToSuppress

      Method[] getMethodsToSuppress()
      Returns:
      Which methods that should be suppressed/stubbed (i.e. return a default value when invoked).

    • getStubbedMethods

      Map<Method,Object> getStubbedMethods()
      Get all substitute return values and also returns an unmodifiable map of all method-object pairs the were initialized.

    • getSubstituteReturnValues

      @Deprecated Map<Method,Object> getSubstituteReturnValues()
      Deprecated.
      Use getStubbedMethods() instead.
      Get all substitute return values and also returns an unmodifiable map of all method-object pairs the were initialized.

    • getFieldsToSuppress

      Field[] getFieldsToSuppress()
      Returns:
      Which fields should be suppressed (i.e. will be set to null or other default values).

    • getFieldTypesToSuppress

      String[] getFieldTypesToSuppress()
      Returns:
      The fully-qualified names to the fields that should be suppressed.