Package springfox.documentation.schema

Class Example

java.lang.Object

springfox.documentation.schema.Example

public class Example
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Example(java.lang.Object value)	Deprecated.
Example(java.lang.String mediaType, java.lang.Object value)	Deprecated.
Example(java.lang.String id, java.lang.String summary, java.lang.String description, java.lang.Object value, java.lang.String externalValue, java.lang.String mediaType)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getDescription()
java.util.List<VendorExtension>	getExtensions()
java.lang.String	getExternalValue()
java.lang.String	getId()
java.util.Optional<java.lang.String>	getMediaType()
java.lang.String	getSummary()
java.lang.Object	getValue()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Example

@Deprecated
public Example(java.lang.Object value)

Deprecated.

Parameters:

value - - example literal

Since:

3.0.0 Use @see Example(String, String, String, Object, String, String)

Example

@Deprecated
public Example(java.lang.String mediaType,
               java.lang.Object value)

Deprecated.

Parameters:

mediaType - - media type of the example

value - - example literal

Since:

3.0.0 Use @see Example(String, String, String, Object, String, String)

Example

public Example(java.lang.String id,
               java.lang.String summary,
               java.lang.String description,
               java.lang.Object value,
               java.lang.String externalValue,
               java.lang.String mediaType)

Method Detail

getId

public java.lang.String getId()

getSummary

public java.lang.String getSummary()

getDescription

public java.lang.String getDescription()

getExternalValue

public java.lang.String getExternalValue()

getExtensions

public java.util.List<VendorExtension> getExtensions()

getValue

public java.lang.Object getValue()

getMediaType

public java.util.Optional<java.lang.String> getMediaType()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object