org.ujorm.tools.web.json

Class JsonBuilder

java.lang.Object

org.ujorm.tools.web.json.JsonBuilder

All Implemented Interfaces:

Closeable, AutoCloseable

public class JsonBuilder
extends Object
implements Closeable

Simple JSON writer for object type of key-value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonBuilder.SelectorType CSS selector types

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonBuilder(Appendable writer) Constructor with a default HTML config
protected	JsonBuilder(Appendable writer, HtmlConfig config) Common constructor

Method Summary

Modifier and Type	Method and Description
void	close()
static JsonBuilder	of(Appendable writer) An object factory
static JsonBuilder	of(HtmlConfig config, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) An object factory
static JsonBuilder	of(HtmlConfig config, javax.servlet.http.HttpServletResponse response) An object factory
static JsonBuilder	of(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) An object factory
static JsonBuilder	of(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, HtmlConfig config) Deprecated.
JsonBuilder	write(CharSequence key, CharSequence... values) Write a key-value
JsonBuilder	write(CharSequence key, ValueProvider valueProvider) Write a key-value
JsonBuilder	write(String keyPrefix, CharSequence key, CharSequence... values) Write a key-value
JsonBuilder	write(String keyPrefix, CharSequence key, ValueProvider valueProvider)
JsonBuilder	writeClass(CharSequence elementId, CharSequence... values) Write the value for a CSS CLASS selector
JsonBuilder	writeClass(CharSequence elementId, ValueProvider valueProvider) Write the value for a CSS CLASS selector
JsonBuilder	writeClassObj(CharSequence elementId, ObjectProvider objectProvider) An experimental feature: write the value for a CSS CLASS selector
JsonBuilder	writeId(CharSequence elementId, CharSequence... values) Write the value for a CSS ID selector
JsonBuilder	writeId(CharSequence elementId, ValueProvider valueProvider) Write the value for a CSS ID selector
JsonBuilder	writeIdObj(CharSequence elementId, ObjectProvider objectProvider) An experimental feature: write the value for a CSS ID selector
JsonBuilder	writeObj(CharSequence key, ObjectProvider objectProvider) An experimental feature: write a key-object value
JsonBuilder	writeObj(String keyPrefix, CharSequence key, ObjectProvider objectProvider) An experimental feature: write key-object value

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonBuilder

protected JsonBuilder(@Nonnull
                      Appendable writer)

Constructor with a default HTML config

JsonBuilder

protected JsonBuilder(@Nonnull
                      Appendable writer,
                      HtmlConfig config)

Common constructor

Method Detail

writeId

public JsonBuilder writeId(@Nonnull
                           CharSequence elementId,
                           @Nullable
                           CharSequence... values)
                    throws IOException

Write the value for a CSS ID selector

Parameters:

elementId - ID selector

values - The text array to join.

Throws:

IOException

writeClass

public JsonBuilder writeClass(@Nonnull
                              CharSequence elementId,
                              @Nullable
                              CharSequence... values)
                       throws IOException

Write the value for a CSS CLASS selector

Parameters:

elementId - ID selector

values - The text array to join.

Throws:

IOException

write

public JsonBuilder write(@Nonnull
                         CharSequence key,
                         @Nullable
                         CharSequence... values)
                  throws IOException

Write a key-value

Parameters:

key - A JSON key

values - The text array to join.

Throws:

IOException

write

public JsonBuilder write(@Nonnull
                         String keyPrefix,
                         @Nonnull
                         CharSequence key,
                         @Nullable
                         CharSequence... values)
                  throws IOException

Write a key-value

Parameters:

key - A JSON key

values - The text array to join.

Throws:

IOException

writeId

public JsonBuilder writeId(@Nonnull
                           CharSequence elementId,
                           @Nonnull
                           ValueProvider valueProvider)
                    throws IOException

Write the value for a CSS ID selector

Parameters:

elementId - ID selector

valueProvider - A value provider

Throws:

IOException

writeClass

public JsonBuilder writeClass(@Nonnull
                              CharSequence elementId,
                              @Nonnull
                              ValueProvider valueProvider)
                       throws IOException

Write the value for a CSS CLASS selector

Parameters:

elementId - ID selector

valueProvider - A value provider

Throws:

IOException

write

public JsonBuilder write(@Nonnull
                         CharSequence key,
                         @Nonnull
                         ValueProvider valueProvider)
                  throws IOException

Write a key-value

Parameters:

key - A JSON key

valueProvider - A value provider

Throws:

IOException

write

public JsonBuilder write(@Nonnull
                         String keyPrefix,
                         @Nonnull
                         CharSequence key,
                         @Nonnull
                         ValueProvider valueProvider)
                  throws IOException

Parameters:

keyPrefix - Key Prefix

key - Main Key

valueProvider - A value provider

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

writeIdObj

public JsonBuilder writeIdObj(@Nonnull
                              CharSequence elementId,
                              @Nonnull
                              ObjectProvider objectProvider)
                       throws IOException

An experimental feature: write the value for a CSS ID selector

Parameters:

elementId - ID selector

objectProvider - A value provider

Throws:

IOException

writeClassObj

public JsonBuilder writeClassObj(@Nonnull
                                 CharSequence elementId,
                                 @Nonnull
                                 ObjectProvider objectProvider)
                          throws IOException

An experimental feature: write the value for a CSS CLASS selector

Parameters:

elementId - ID selector

objectProvider - A value provider

Throws:

IOException

writeObj

public JsonBuilder writeObj(@Nonnull
                            CharSequence key,
                            @Nonnull
                            ObjectProvider objectProvider)
                     throws IOException

An experimental feature: write a key-object value

Parameters:

key - A JSON key

objectProvider - A value provider

Throws:

IOException

writeObj

public JsonBuilder writeObj(@Nonnull
                            String keyPrefix,
                            @Nonnull
                            CharSequence key,
                            @Nonnull
                            ObjectProvider objectProvider)
                     throws IOException

An experimental feature: write key-object value

Parameters:

keyPrefix - Key Prefix

key - Main Key

objectProvider - A value provider

Throws:

IOException

of

@Nonnull
public static final JsonBuilder of(@Nonnull
                                            Appendable writer)

An object factory

of

@Nonnull
public static final JsonBuilder of(@Nonnull
                                            javax.servlet.http.HttpServletRequest request,
                                            @Nonnull
                                            javax.servlet.http.HttpServletResponse response)
                                     throws IllegalStateException,
                                            IOException

An object factory

Throws:

IllegalStateException

IOException

of

@Nonnull
public static final JsonBuilder of(@Nonnull
                                            HtmlConfig config,
                                            @Nonnull
                                            javax.servlet.http.HttpServletResponse response)
                                     throws IllegalStateException,
                                            IOException

An object factory

Throws:

IllegalStateException

IOException

of

@Deprecated
 @Nonnull
public static final JsonBuilder of(@Nullable
                                                         javax.servlet.http.HttpServletRequest request,
                                                         @Nonnull
                                                         javax.servlet.http.HttpServletResponse response,
                                                         @Nonnull
                                                         HtmlConfig config)
                                                  throws IllegalStateException,
                                                         IOException

Deprecated.

An object factory

Throws:

IllegalStateException

IOException

of

@Nonnull
public static final JsonBuilder of(@Nonnull
                                            HtmlConfig config,
                                            @Nullable
                                            javax.servlet.http.HttpServletRequest request,
                                            @Nonnull
                                            javax.servlet.http.HttpServletResponse response)
                                     throws IllegalStateException,
                                            IOException

An object factory

Throws:

IllegalStateException

IOException