springfox.documentation.builders

Class ResponseMessageBuilder

java.lang.Object

springfox.documentation.builders.ResponseMessageBuilder

public class ResponseMessageBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ResponseMessageBuilder()

Method Summary

Modifier and Type	Method and Description
ResponseMessage	build()
ResponseMessageBuilder	code(int code) Updates the http response code
ResponseMessageBuilder	headers(java.util.Map<java.lang.String,ModelReference> headers) Deprecated. Use the headersWithDescription(java.util.Map<java.lang.String, springfox.documentation.service.Header>) instead
ResponseMessageBuilder	headersWithDescription(java.util.Map<java.lang.String,Header> headers) Updates the response headers
ResponseMessageBuilder	message(java.lang.String message) Updates the response message
ResponseMessageBuilder	responseModel(ModelReference responseModel) Updates the model the response represents
ResponseMessageBuilder	vendorExtensions(java.util.List<VendorExtension> extensions) Updates the response message extensions

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseMessageBuilder

public ResponseMessageBuilder()

Method Detail

code

public ResponseMessageBuilder code(int code)

Updates the http response code

Parameters:

code - - response code

Returns:

this

message

public ResponseMessageBuilder message(java.lang.String message)

Updates the response message

Parameters:

message - - message

Returns:

this

responseModel

public ResponseMessageBuilder responseModel(ModelReference responseModel)

Updates the model the response represents

Parameters:

responseModel - - model reference

Returns:

this

headers

@Deprecated
public ResponseMessageBuilder headers(java.util.Map<java.lang.String,ModelReference> headers)

Deprecated. Use the headersWithDescription(java.util.Map<java.lang.String, springfox.documentation.service.Header>) instead

Updates the response headers

Parameters:

headers - header responses

Returns:

this

Since:

2.5.0

headersWithDescription

public ResponseMessageBuilder headersWithDescription(java.util.Map<java.lang.String,Header> headers)

Updates the response headers

Parameters:

headers - headers with description

Returns:

this

Since:

2.5.0

vendorExtensions

public ResponseMessageBuilder vendorExtensions(java.util.List<VendorExtension> extensions)

Updates the response message extensions

Parameters:

extensions - - response message extensions

Returns:

this

Since:

2.5.0

build

public ResponseMessage build()