DefaultJsonGenerator (Grails Views 3.2.3)

grails.plugin.json.builder.DefaultJsonGenerator

All Implemented Interfaces and Traits:

JsonGenerator
```
public class DefaultJsonGenerator
```
Temporary fork of DefaultJsonGenerator until Groovy 2.5.0 is out.
A JsonGenerator that can be configured with various JsonGenerator.Options. If the default options are sufficient consider using the static JsonOutput.toJson methods.
See Also:
JsonGenerator.Options#build()
Since:
2.5

Nested Class Summary

Nested classes
Modifiers	Name	Description
`protected static class`	`DefaultJsonGenerator.ClosureConverter`	A converter that handles converting a given type to a JSON value using a closure.

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.Set<Converter>`	`converters`
`protected java.lang.String`	`dateFormat`
`protected java.util.Locale`	`dateLocale`
`protected boolean`	`disableUnicodeEscaping`
`protected boolean`	`excludeNulls`
`protected java.util.Set<java.lang.String>`	`excludedFieldNames`
`protected java.util.Set<java.lang.Class<?>>`	`excludedFieldTypes`
`protected java.util.TimeZone`	`timezone`

Constructor Summary

Constructors
Constructor and description
`protected DefaultJsonGenerator (Options options)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected Converter`	`findConverter(java.lang.Class<?> type)` Finds a converter that can handle the given type.
	`protected java.util.Map<?, ?>`	`getObjectProperties(java.lang.Object object)`
	`public boolean`	`isExcludingFieldsNamed(java.lang.String name)` {@inheritDoc}
	`public boolean`	`isExcludingValues(java.lang.Object value)` {@inheritDoc}
	`protected boolean`	`shouldExcludeType(java.lang.Class<?> type)` Indicates whether the given type should be excluded from the generated output.
	`public java.lang.String`	`toJson(java.lang.Object object)` {@inheritDoc}
	`protected void`	`writeArray(java.lang.Class<?> arrayClass, java.lang.Object array, org.apache.groovy.json.internal.CharBuf buffer)` Serializes array and writes it into specified buffer.
	`protected void`	`writeCharSequence(java.lang.CharSequence seq, org.apache.groovy.json.internal.CharBuf buffer)` Serializes any char sequence and writes it into specified buffer.
	`protected void`	`writeDate(java.util.Date date, org.apache.groovy.json.internal.CharBuf buffer)` Serializes date and writes it into specified buffer.
	`protected void`	`writeIterator(java.util.Iterator<?> iterator, org.apache.groovy.json.internal.CharBuf buffer)` Serializes iterator and writes it into specified buffer.
	`protected void`	`writeMap(java.util.Map<?, ?> map, org.apache.groovy.json.internal.CharBuf buffer)` Serializes map and writes it into specified buffer.
	`protected void`	`writeMapEntry(java.lang.String key, java.lang.Object value, org.apache.groovy.json.internal.CharBuf buffer)` Serializes a map entry and writes it into specified buffer.
	`protected void`	`writeNumber(java.lang.Class<?> numberClass, java.lang.Number value, org.apache.groovy.json.internal.CharBuf buffer)` Serializes Number value and writes it into specified buffer.
	`protected void`	`writeObject(java.lang.Object object, org.apache.groovy.json.internal.CharBuf buffer)`
	`protected void`	`writeObject(java.lang.String key, java.lang.Object object, org.apache.groovy.json.internal.CharBuf buffer)` Serializes object and writes it into specified buffer.
	`protected void`	`writeRaw(java.lang.CharSequence seq, org.apache.groovy.json.internal.CharBuf buffer)` Serializes any char sequence and writes it into specified buffer without performing any manipulation of the given text.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected final java.util.Set<Converter> converters
  - protected final java.lang.String dateFormat
  - protected final java.util.Locale dateLocale
  - protected final boolean disableUnicodeEscaping
  - protected final boolean excludeNulls
  - protected final java.util.Set<java.lang.String> excludedFieldNames
  - protected final java.util.Set<java.lang.Class<?>> excludedFieldTypes
  - protected final java.util.TimeZone timezone
- Constructor Detail
  - protected DefaultJsonGenerator(Options options)
- Method Detail
  - protected Converter findConverter(java.lang.Class<?> type)
    
    Finds a converter that can handle the given type. The first converter that reports it can handle the type is returned, based on the order in which the converters were specified. A null value will be returned if no suitable converter can be found for the given type.
    Parameters:
    type - that this converter can handle
    Returns:
    first converter that can handle the given type; else null if no compatible converters are found for the given type.
  - protected java.util.Map<?, ?> getObjectProperties(java.lang.Object object)
  - @java.lang.Override public boolean isExcludingFieldsNamed(java.lang.String name)
    
    {@inheritDoc}
  - @java.lang.Override public boolean isExcludingValues(java.lang.Object value)
    
    {@inheritDoc}
  - protected boolean shouldExcludeType(java.lang.Class<?> type)
    
    Indicates whether the given type should be excluded from the generated output.
    Parameters:
    type - the type to check
    Returns:
    true if the given type should not be output, else false
  - @java.lang.Override public java.lang.String toJson(java.lang.Object object)
    
    {@inheritDoc}
  - protected void writeArray(java.lang.Class<?> arrayClass, java.lang.Object array, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes array and writes it into specified buffer.
    Parameters:
    arrayClass - the Array class
    array - an array to serialize into JSON
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value
  - protected void writeCharSequence(java.lang.CharSequence seq, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes any char sequence and writes it into specified buffer.
    Parameters:
    seq - a java.lang.CharSequence to serialize and encode
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value
  - protected void writeDate(java.util.Date date, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes date and writes it into specified buffer.
    Parameters:
    date - A java.util.Date to serialize into JSON string
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value
  - protected void writeIterator(java.util.Iterator<?> iterator, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes iterator and writes it into specified buffer.
    Parameters:
    iterator - a java.util.Iterator to serialize to JSON string
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value
  - protected void writeMap(java.util.Map<?, ?> map, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes map and writes it into specified buffer.
    Parameters:
    map - a java.util.Map to serialize to JSON string
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value
  - protected void writeMapEntry(java.lang.String key, java.lang.Object value, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes a map entry and writes it into specified buffer.
    Parameters:
    key - a Map.Entry key
    value - a Map.Entry value
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value
  - protected void writeNumber(java.lang.Class<?> numberClass, java.lang.Number value, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes Number value and writes it into specified buffer.
    Parameters:
    numberClass - The object java.lang.Class
    value - a java.lang.Number
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value
  - protected void writeObject(java.lang.Object object, org.apache.groovy.json.internal.CharBuf buffer)
  - protected void writeObject(java.lang.String key, java.lang.Object object, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes object and writes it into specified buffer.
    Parameters:
    key - the name for the value
    object - to convert to JSON
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value
  - protected void writeRaw(java.lang.CharSequence seq, org.apache.groovy.json.internal.CharBuf buffer)
    
    Serializes any char sequence and writes it into specified buffer without performing any manipulation of the given text.
    Parameters:
    seq - a java.lang.CharSequence to serialize to string
    buffer - a org.apache.groovy.json.internal.CharBuf buffer to write the serialized value

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class DefaultJsonGenerator

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final java.util.Set<Converter> converters

protected final java.lang.String dateFormat

protected final java.util.Locale dateLocale

protected final boolean disableUnicodeEscaping

protected final boolean excludeNulls

protected final java.util.Set<java.lang.String> excludedFieldNames

protected final java.util.Set<java.lang.Class<?>> excludedFieldTypes

protected final java.util.TimeZone timezone

Constructor Detail

protected DefaultJsonGenerator(Options options)

Method Detail

protected Converter findConverter(java.lang.Class<?> type)

protected java.util.Map<?, ?> getObjectProperties(java.lang.Object object)

@java.lang.Override public boolean isExcludingFieldsNamed(java.lang.String name)

@java.lang.Override public boolean isExcludingValues(java.lang.Object value)

protected boolean shouldExcludeType(java.lang.Class<?> type)

@java.lang.Override public java.lang.String toJson(java.lang.Object object)

protected void writeArray(java.lang.Class<?> arrayClass, java.lang.Object array, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeCharSequence(java.lang.CharSequence seq, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeDate(java.util.Date date, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeIterator(java.util.Iterator<?> iterator, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeMap(java.util.Map<?, ?> map, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeMapEntry(java.lang.String key, java.lang.Object value, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeNumber(java.lang.Class<?> numberClass, java.lang.Number value, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeObject(java.lang.Object object, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeObject(java.lang.String key, java.lang.Object object, org.apache.groovy.json.internal.CharBuf buffer)

protected void writeRaw(java.lang.CharSequence seq, org.apache.groovy.json.internal.CharBuf buffer)