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(@NotNull Appendable writer) Constructor with a default HTML config
protected	JsonBuilder(@NotNull Appendable writer, HtmlConfig config) Common constructor

Method Summary

Modifier and Type	Method and Description
void	close()
static @NotNull JsonBuilder	of(@NotNull Appendable writer) An object factory
static @NotNull JsonBuilder	of(@NotNull Appendable writer, @NotNull HtmlConfig config) An object factory.
static @NotNull JsonBuilder	of(@NotNull RContext context) An object factory
static @NotNull JsonBuilder	of(@NotNull RContext context, @NotNull HtmlConfig config) An object factory
JsonBuilder	write(@NotNull CharSequence key, CharSequence... values) Write a key-value
JsonBuilder	write(@NotNull CharSequence key, @NotNull ValueProvider valueProvider) Write a key-value
JsonBuilder	write(@NotNull String keyPrefix, @NotNull CharSequence key, @NotNull ValueProvider valueProvider)
JsonBuilder	writeClass(@NotNull CharSequence elementId, CharSequence... values) Write the value for a CSS CLASS selector
JsonBuilder	writeClass(@NotNull CharSequence elementId, @NotNull ValueProvider valueProvider) Write the value for a CSS CLASS selector
JsonBuilder	writeClassObj(@NotNull CharSequence elementId, @NotNull ObjectProvider objectProvider) An experimental feature: write the value for a CSS CLASS selector
JsonBuilder	writeId(@NotNull CharSequence elementId, CharSequence... values) Write the value for a CSS ID selector
JsonBuilder	writeId(@NotNull CharSequence elementId, @NotNull ValueProvider valueProvider) Write the value for a CSS ID selector
JsonBuilder	writeIdObj(@NotNull CharSequence elementId, @NotNull ObjectProvider objectProvider) An experimental feature: write the value for a CSS ID selector
JsonBuilder	writeJs(CharSequence... javascript) Write a Javascript to a call.
JsonBuilder	writeObj(@NotNull CharSequence key, @NotNull ObjectProvider objectProvider) An experimental feature: write a key-object value
JsonBuilder	writeObj(@NotNull String keyPrefix, @NotNull CharSequence key, @NotNull ObjectProvider objectProvider) An experimental feature: write key-object value
JsonBuilder	writePrefix(@NotNull String keyPrefix, @NotNull CharSequence key, CharSequence... values) Write a key-value with a prefix

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonBuilder

protected JsonBuilder(@NotNull
                      @NotNull Appendable writer)

Constructor with a default HTML config

JsonBuilder

protected JsonBuilder(@NotNull
                      @NotNull Appendable writer,
                      HtmlConfig config)

Common constructor

Method Detail

writeId

public JsonBuilder writeId(@NotNull
                           @NotNull 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(@NotNull
                              @NotNull 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(@NotNull
                         @NotNull CharSequence key,
                         @Nullable
                         CharSequence... values)
                  throws IOException

Write a key-value

Parameters:

key - A JSON key

values - The text array to join.

Throws:

IOException

writePrefix

public JsonBuilder writePrefix(@NotNull
                               @NotNull String keyPrefix,
                               @NotNull
                               @NotNull CharSequence key,
                               @Nullable
                               CharSequence... values)
                        throws IOException

Write a key-value with a prefix

Parameters:

key - A JSON key

values - The text array to join.

Throws:

IOException

writeJs

public JsonBuilder writeJs(@Nullable
                           CharSequence... javascript)
                    throws IOException

Write a Javascript to a call. The response can contain only one Javascript code, so this method can be called only once per request.

Throws:

IOException

writeId

public JsonBuilder writeId(@NotNull
                           @NotNull CharSequence elementId,
                           @NotNull
                           @NotNull 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(@NotNull
                              @NotNull CharSequence elementId,
                              @NotNull
                              @NotNull 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(@NotNull
                         @NotNull CharSequence key,
                         @NotNull
                         @NotNull ValueProvider valueProvider)
                  throws IOException

Write a key-value

Parameters:

key - A JSON key

valueProvider - A value provider

Throws:

IOException

write

public JsonBuilder write(@NotNull
                         @NotNull String keyPrefix,
                         @NotNull
                         @NotNull CharSequence key,
                         @NotNull
                         @NotNull 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(@NotNull
                              @NotNull CharSequence elementId,
                              @NotNull
                              @NotNull 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(@NotNull
                                 @NotNull CharSequence elementId,
                                 @NotNull
                                 @NotNull 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(@NotNull
                            @NotNull CharSequence key,
                            @NotNull
                            @NotNull 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(@NotNull
                            @NotNull String keyPrefix,
                            @NotNull
                            @NotNull CharSequence key,
                            @NotNull
                            @NotNull 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

@NotNull
public static final @NotNull JsonBuilder of(@NotNull
                                                     @NotNull RContext context,
                                                     @NotNull
                                                     @NotNull HtmlConfig config)

An object factory

of

@NotNull
public static final @NotNull JsonBuilder of(@NotNull
                                                     @NotNull RContext context)

An object factory

of

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

An object factory

of

@NotNull
public static final @NotNull JsonBuilder of(@NotNull
                                                     @NotNull Appendable writer,
                                                     @NotNull
                                                     @NotNull HtmlConfig config)

An object factory. The MAIN factory method.