JsonFieldType

java.lang.Object
- java.lang.Enum<JsonFieldType>
- - org.springframework.restdocs.payload.JsonFieldType

All Implemented Interfaces:

Serializable, Comparable<JsonFieldType>
```
public enum JsonFieldType
extends Enum<JsonFieldType>
```
An enumeration of the possible types for a field in a JSON request or response payload.

Author:

Andy Wilkinson

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARRAY` An array.
`BOOLEAN` A boolean value.
`NULL` `null`.
`NUMBER` A number.
`OBJECT` An object (map).
`STRING` A string.
`VARIES` A variety of different types.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`toString()`
`static JsonFieldType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static JsonFieldType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ARRAY
```
public static final JsonFieldType ARRAY
```
    An array.
  - BOOLEAN
```
public static final JsonFieldType BOOLEAN
```
    A boolean value.
  - OBJECT
```
public static final JsonFieldType OBJECT
```
    An object (map).
  - NUMBER
```
public static final JsonFieldType NUMBER
```
    A number.
  - NULL
```
public static final JsonFieldType NULL
```
    null.
  - STRING
```
public static final JsonFieldType STRING
```
    A string.
  - VARIES
```
public static final JsonFieldType VARIES
```
    A variety of different types.
- Method Detail
  - values
```
public static JsonFieldType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (JsonFieldType c : JsonFieldType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JsonFieldType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<JsonFieldType>

Enum JsonFieldType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ARRAY

BOOLEAN

OBJECT

NUMBER

NULL

STRING

VARIES

Method Detail

values

valueOf

toString