JSON (Grails 7.0.0-SNAPSHOT)

grails.converters.JSON

All Implemented Interfaces and Traits:

IncludeExcludeConverter
```
public class JSON
extends AbstractConverter
implements IncludeExcludeConverter
```
A converter that converts domain classes, Maps, Lists, Arrays, POJOs and POGOs to JSON.
Authors:
Siegfried Puchbauer
Graeme Rocher

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`JSON.Builder`
`private enum`	`JSON.BuilderMode`

Field Summary

Fields
Modifiers	Name	Description
`private static java.lang.String`	`CACHED_JSON`
`protected CircularReferenceBehaviour`	`circularReferenceBehaviour`
`protected ConverterConfiguration<JSON>`	`config`
`private static org.apache.commons.logging.Log`	`log`
`protected boolean`	`prettyPrint`
`protected java.util.Stack<java.lang.Object>`	`referenceStack`
`protected java.lang.Object`	`target`
`protected JSONWriter`	`writer`

Inherited fields
Fields inherited from class	Fields
`class AbstractConverter`	`contentType, encoding, excludes, includes`

Constructor Summary

Constructors
Constructor and description
`JSON()` Default Constructor for a JSON Converter
`JSON(java.lang.Object target)` Creates a new JSON Converter for the given Object

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`build(groovy.lang.Closure c)`
	`public void`	`convertAnother(java.lang.Object o)`
	`public static void`	`createNamedConfig(java.lang.String name, groovy.lang.Closure<?> callable)`
	`private void`	`finalizeRender(java.io.Writer out)`
	`public int`	`getDepth()`
	`public static ConverterConfiguration<JSON>`	`getNamedConfig(java.lang.String configName)`
	`public JSONWriter`	`getWriter()`
	`protected void`	`handleCircularRelationship(java.lang.Object o)`
	`protected ConverterConfiguration<JSON>`	`initConfig()`
	`public ObjectMarshaller<JSON>`	`lookupObjectMarshaller(java.lang.Object target)`
	`public static JSONElement`	`parse(java.io.Reader reader)` Parses the given JSON String and returns either a JSONObject or a JSONArray
	`public static JSONElement`	`parse(java.lang.String source)` Parses the given JSON String and returns either a JSONObject or a JSONArray
	`public static JSONElement`	`parse(java.io.InputStream is, java.lang.String encoding)` Parses the given JSON and returns either a JSONObject or a JSONArray
	`public static java.lang.Object`	`parse(jakarta.servlet.http.HttpServletRequest request)` Parses the given request's InputStream and returns either a JSONObject or a JSONArray
	`private void`	`prepareRender(java.io.Writer out)`
	`public void`	`property(java.lang.String key, java.lang.Object value)`
	`public static void`	`registerObjectMarshaller(java.lang.Class<?> clazz, groovy.lang.Closure<?> callable)`
	`public static void`	`registerObjectMarshaller(java.lang.Class<?> clazz, int priority, groovy.lang.Closure<?> callable)`
	`public static void`	`registerObjectMarshaller(ObjectMarshaller<JSON> om)`
	`public static void`	`registerObjectMarshaller(ObjectMarshaller<JSON> om, int priority)`
	`public void`	`render(java.io.Writer out)` Directs the JSON Writer to the given Writer
	`public void`	`render(jakarta.servlet.http.HttpServletResponse response)` Directs the JSON Writer to the Outputstream of the HttpServletResponse and sets the Content-Type to application/json
	`public void`	`setExcludes(java.util.List<java.lang.String> excludes)`
	`public void`	`setIncludes(java.util.List<java.lang.String> includes)`
	`public void`	`setPrettyPrint(boolean prettyPrint)`
	`public void`	`setTarget(java.lang.Object target)` Sets the Object which is later converted to JSON
	`public java.lang.String`	`toString(boolean prettyPrint)` Performs the conversion and returns the resulting JSON as String
	`public static java.lang.Object`	`use(java.lang.String configName, groovy.lang.Closure<?> callable)`
	`public static void`	`use(java.lang.String cfgName)`
	`public void`	`value(java.lang.Object o)` Parameters: o
	`public static void`	`withDefaultConfiguration(groovy.lang.Closure<?> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractConverter`	`createBeanWrapper, getExcludes, getIncludes, setContentType, setEncoding, setExcludes, setIncludes, setTarget, toString, writeTo`

- Field Detail
  - private static final java.lang.String CACHED_JSON
  - protected final CircularReferenceBehaviour circularReferenceBehaviour
  - protected final ConverterConfiguration<JSON> config
  - private static final org.apache.commons.logging.Log log
  - protected boolean prettyPrint
  - protected java.util.Stack<java.lang.Object> referenceStack
  - protected java.lang.Object target
  - protected JSONWriter writer
- Constructor Detail
  - public JSON()
    
    Default Constructor for a JSON Converter
  - public JSON(java.lang.Object target)
    
    Creates a new JSON Converter for the given Object
    Parameters:
    target - the Object to convert
- Method Detail
  - public void build(@java.lang.SuppressWarnings("rawtypes")
    groovy.lang.Closure c)
  - public void convertAnother(java.lang.Object o)
  - public static void createNamedConfig(java.lang.String name, groovy.lang.Closure<?> callable)
  - private void finalizeRender(java.io.Writer out)
  - public int getDepth()
  - public static ConverterConfiguration<JSON> getNamedConfig(java.lang.String configName)
  - public JSONWriter getWriter()
  - protected void handleCircularRelationship(java.lang.Object o)
  - protected ConverterConfiguration<JSON> initConfig()
  - public ObjectMarshaller<JSON> lookupObjectMarshaller(java.lang.Object target)
  - public static JSONElement parse(java.io.Reader reader)
    
    Parses the given JSON String and returns either a JSONObject or a JSONArray
    throws:
    ConverterException when the JSON content is not valid
    
    Parameters:
    reader - JSON source
    Returns:
    either a JSONObject or a JSONArray - depending on the given JSON
  - public static JSONElement parse(java.lang.String source)
    
    Parses the given JSON String and returns either a JSONObject or a JSONArray
    throws:
    ConverterException when the JSON content is not valid
    
    Parameters:
    source - A string containing some JSON
    Returns:
    either a JSONObject or a JSONArray - depending on the given JSON
  - public static JSONElement parse(java.io.InputStream is, java.lang.String encoding)
    
    Parses the given JSON and returns either a JSONObject or a JSONArray
    throws:
    ConverterException when the JSON content is not valid
    
    Parameters:
    is - An InputStream which delivers some JSON
    encoding - the Character Encoding to use
    Returns:
    either a JSONObject or a JSONArray - depending on the given JSON
  - public static java.lang.Object parse(jakarta.servlet.http.HttpServletRequest request)
    
    Parses the given request's InputStream and returns either a JSONObject or a JSONArray
    throws:
    ConverterException when the JSON content is not valid
    
    Parameters:
    request - the JSON Request
    Returns:
    either a JSONObject or a JSONArray - depending on the given JSON
  - private void prepareRender(java.io.Writer out)
  - public void property(java.lang.String key, java.lang.Object value)
  - public static void registerObjectMarshaller(java.lang.Class<?> clazz, groovy.lang.Closure<?> callable)
  - public static void registerObjectMarshaller(java.lang.Class<?> clazz, int priority, groovy.lang.Closure<?> callable)
  - public static void registerObjectMarshaller(ObjectMarshaller<JSON> om)
  - public static void registerObjectMarshaller(ObjectMarshaller<JSON> om, int priority)
  - public void render(java.io.Writer out)
    
    Directs the JSON Writer to the given Writer
    throws:
    org.grails.web.converters.exceptions.ConverterException
    
    Parameters:
    out - the Writer
  - public void render(jakarta.servlet.http.HttpServletResponse response)
    
    Directs the JSON Writer to the Outputstream of the HttpServletResponse and sets the Content-Type to application/json
    throws:
    ConverterException
    
    Parameters:
    response - a HttpServletResponse
  - @java.lang.Override
    public void setExcludes(java.util.List<java.lang.String> excludes)
  - @java.lang.Override
    public void setIncludes(java.util.List<java.lang.String> includes)
  - public void setPrettyPrint(boolean prettyPrint)
  - @java.lang.Override
    public void setTarget(java.lang.Object target)
    
    Sets the Object which is later converted to JSON
    Parameters:
    target - the Object
    See Also:
    Converter
  - public java.lang.String toString(boolean prettyPrint)
    
    Performs the conversion and returns the resulting JSON as String
    throws:
    JSONException
    
    Parameters:
    prettyPrint - true, if the output should be indented, otherwise false
    Returns:
    a JSON String
  - public static java.lang.Object use(java.lang.String configName, groovy.lang.Closure<?> callable)
  - public static void use(java.lang.String cfgName)
  - public void value(java.lang.Object o)
    
    throws:
    ConverterException
    
    Parameters:
    o
  - public static void withDefaultConfiguration(groovy.lang.Closure<?> callable)

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class JSON

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static final java.lang.String CACHED_JSON

protected final CircularReferenceBehaviour circularReferenceBehaviour

protected final ConverterConfiguration<JSON> config

private static final org.apache.commons.logging.Log log

protected boolean prettyPrint

protected java.util.Stack<java.lang.Object> referenceStack

protected java.lang.Object target

protected JSONWriter writer

Constructor Detail

public JSON()

public JSON(java.lang.Object target)

Method Detail

public void build(@java.lang.SuppressWarnings("rawtypes")groovy.lang.Closure c)

public void convertAnother(java.lang.Object o)

public static void createNamedConfig(java.lang.String name, groovy.lang.Closure<?> callable)

private void finalizeRender(java.io.Writer out)

public int getDepth()

public static ConverterConfiguration<JSON> getNamedConfig(java.lang.String configName)

public JSONWriter getWriter()

protected void handleCircularRelationship(java.lang.Object o)

protected ConverterConfiguration<JSON> initConfig()

public ObjectMarshaller<JSON> lookupObjectMarshaller(java.lang.Object target)

public static JSONElement parse(java.io.Reader reader)

public static JSONElement parse(java.lang.String source)

public static JSONElement parse(java.io.InputStream is, java.lang.String encoding)

public static java.lang.Object parse(jakarta.servlet.http.HttpServletRequest request)

private void prepareRender(java.io.Writer out)

public void property(java.lang.String key, java.lang.Object value)

public static void registerObjectMarshaller(java.lang.Class<?> clazz, groovy.lang.Closure<?> callable)

public static void registerObjectMarshaller(java.lang.Class<?> clazz, int priority, groovy.lang.Closure<?> callable)

public static void registerObjectMarshaller(ObjectMarshaller<JSON> om)

public static void registerObjectMarshaller(ObjectMarshaller<JSON> om, int priority)

public void render(java.io.Writer out)

public void render(jakarta.servlet.http.HttpServletResponse response)

@java.lang.Overridepublic void setExcludes(java.util.List<java.lang.String> excludes)

@java.lang.Overridepublic void setIncludes(java.util.List<java.lang.String> includes)

public void setPrettyPrint(boolean prettyPrint)

@java.lang.Overridepublic void setTarget(java.lang.Object target)

public java.lang.String toString(boolean prettyPrint)

public static java.lang.Object use(java.lang.String configName, groovy.lang.Closure<?> callable)

public static void use(java.lang.String cfgName)

public void value(java.lang.Object o)

public static void withDefaultConfiguration(groovy.lang.Closure<?> callable)

public void build(@java.lang.SuppressWarnings("rawtypes")
groovy.lang.Closure c)

@java.lang.Override
public void setExcludes(java.util.List<java.lang.String> excludes)

@java.lang.Override
public void setIncludes(java.util.List<java.lang.String> includes)

@java.lang.Override
public void setTarget(java.lang.Object target)