net.java.html.json

Class Models

java.lang.Object

net.java.html.json.Models

public final class Models
extends java.lang.Object

Information about and operations for classes generated by the @Model annotation.

Author:

Jaroslav Tulach

Method Summary

Modifier and Type	Method and Description
static void	applyBindings(java.lang.Object model) Apply bindings of a model class to overall page.
static void	applyBindings(java.lang.Object model, java.lang.String targetId) Apply bindings of a model class.
static <T> java.util.List<T>	asList(T... values) Wrap provided values into mutable list.
static <Model> Model	bind(Model model, net.java.html.BrwsrCtx context) Binds given model to another context.
static <M> M	fromRaw(net.java.html.BrwsrCtx ctx, java.lang.Class<M> model, java.lang.Object jsonObject) Converts an existing, raw, JSON object into a model class.
static boolean	isModel(java.lang.Class<?> clazz) Finds out whether given class is a model class - e.g.
static <M> M	parse(net.java.html.BrwsrCtx c, java.lang.Class<M> model, java.io.InputStream is) Generic method to parse content of a model class from a stream.
static <M> void	parse(net.java.html.BrwsrCtx c, java.lang.Class<M> model, java.io.InputStream is, java.util.Collection<? super M> collectTo) Generic method to parse stream, that can possibly contain array of specified objects.
static java.io.Closeable	react(java.lang.Runnable reaction, java.util.concurrent.Executor onChange) Runs provided action immediately and then again and again when reaction to changes is needed.
static java.lang.Object	toRaw(java.lang.Object model) Converts an existing model into its associated, raw JSON object.

Methods inherited from class java.lang.Object

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

Method Detail

isModel

public static boolean isModel(java.lang.Class<?> clazz)

Finds out whether given class is a model class - e.g. has been generated by @Model annotation.

Parameters:

clazz - the class to test

Returns:

true, if clazz was generated by Model annotation

Since:

0.2

bind

public static <Model> Model bind(Model model,
                                 net.java.html.BrwsrCtx context)

Binds given model to another context.

Type Parameters:

Model - class defined by Model annotation

Parameters:

model - instance of a model defined by Model annotation

context - context to which the model should be bound

Returns:

new instance of model bound to new context

Throws:

java.lang.IllegalArgumentException - in case the instance is not generated by model interface

Since:

0.4

parse

public static <M> M parse(net.java.html.BrwsrCtx c,
                          java.lang.Class<M> model,
                          java.io.InputStream is)
                   throws java.io.IOException

Generic method to parse content of a model class from a stream.

Type Parameters:

M - type of the model class

Parameters:

c - context of the technology to use for reading

model - the model class generated by Model annotation

is - input stream with data

Returns:

new instance of the model class

Throws:

java.io.IOException - throw when reading from is faces problems

Since:

0.2

parse

public static <M> void parse(net.java.html.BrwsrCtx c,
                             java.lang.Class<M> model,
                             java.io.InputStream is,
                             java.util.Collection<? super M> collectTo)
                      throws java.io.IOException

Generic method to parse stream, that can possibly contain array of specified objects.

Type Parameters:

M - the type of the individal JSON object

Parameters:

c - context of the technology to use for reading

model - the model class generated by Model annotation

is - input stream with data

collectTo - collection to add the individual model instances to. If the stream contains an object, one instance will be added, if it contains an array, the number of array items will be added to the collection

Throws:

java.io.IOException - thrown when an I/O problem appears

Since:

0.8.3

fromRaw

public static <M> M fromRaw(net.java.html.BrwsrCtx ctx,
                            java.lang.Class<M> model,
                            java.lang.Object jsonObject)

Converts an existing, raw, JSON object into a model class.

Type Parameters:

M - the type of the model class

Parameters:

ctx - context of the technology to use for converting

model - the model class

jsonObject - original instance of the JSON object

Returns:

new instance of the model class

Since:

0.7

toRaw

public static java.lang.Object toRaw(java.lang.Object model)

Converts an existing model into its associated, raw JSON object. The object may, but does not have to, be the same instance as the model object.

Parameters:

model - the model object (can be null to initialize the associated Technology)

Returns:

the raw JSON object associated with the model (null if the model parameter was null)

Throws:

java.lang.IllegalArgumentException - if the model is not instance of a class generated by model annotation processor.

Since:

0.7

applyBindings

public static void applyBindings(java.lang.Object model)

Apply bindings of a model class to overall page. In ko4j mode, it binds the model values to the currently active page.

Parameters:

model - instance of a class

Throws:

java.lang.IllegalArgumentException - if the model is not instance of a class generated by model annotation processor.

Since:

0.7

applyBindings

public static void applyBindings(java.lang.Object model,
                                 java.lang.String targetId)

Apply bindings of a model class. In ko4j mode, it binds the model values to an element on currently active page.

Parameters:

model - instance of a class

targetId - the id of the element to apply the binding to

Throws:

java.lang.IllegalArgumentException - if the model is not instance of a class generated by model annotation processor.

Since:

1.1

asList

public static <T> java.util.List<T> asList(T... values)

Wrap provided values into mutable list.

Type Parameters:

T - type of the values and resulting list

Parameters:

values - the values, if any

Returns:

full features implementation of mutable and extendable list

Since:

1.5

react

public static java.io.Closeable react(java.lang.Runnable reaction,
                                      java.util.concurrent.Executor onChange)

Runs provided action immediately and then again and again when reaction to changes is needed. The action can access properties of various models. The set of accessed properties is recorded and whenever there is a change in one of such properties, onChange.execute method is called. The set of accessed properties is re-recorded during the latest run. Should one of them change, the whole process is repeated. Simple example that defines a state and observes it follows:

@Model(className = "ReactiveState", properties = {
    @Property(name = "state", type = int.class)
})
static final class ReactiveStateCntrl {
}

class UseReactiveState {
    int counter;
    int value;

    void observeState() throws Exception {
        ReactiveState state = new ReactiveState(7);

        Closeable handle = Models.react(() -> {
            counter++;
            value = state.getState();
        }, (c) -> c.run());

        assertEquals(counter, 1, "reaction performed once initially");
        assertEquals(value, state.getState(), "value recorded");

        state.setState(state.getState() * 2);

        assertEquals(counter, 2, "reaction performed again");
        assertEquals(value, state.getState(), "value re-recorded");

        handle.close();

        state.setState(state.getState() * 3);

        assertEquals(counter, 2, "changes are no longer observed");
        assertNotEquals(value, state.getState(), "value hasn't been updated");

        assertEquals(state.getState(), 42, "the meaning is clear");
    }
}

Parameters:

reaction - the action to (repeatedly) execute

onChange - submits the action again when re-run is needed

Returns:

use close() method to stop observing changes

Since:

1.8