org.netbeans.html.json.spi

Class Proto.Type<Model>

java.lang.Object

org.netbeans.html.json.spi.Proto.Type<Model>

Type Parameters:

Model - the generated class

Enclosing class:

Proto

public abstract static class Proto.Type<Model>
extends Object

Functionality used by the code generated by annotation processor for the Model annotation.

Since:

0.7

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Type(Class<? extends Model> clazz, Class<?> modelFor, int properties, int functions) Constructor for subclasses generated by the annotation processor associated with Model annotation.

Method Summary

Modifier and Type	Method and Description
Boolean	boolValue(Object val) Converts the value to boolean.
protected abstract void	call(Model model, int index, Object data, Object event) Invokes a Proto.Type.registerFunction(java.lang.String, int) registered function on given object.
Character	charValue(Object val) Converts the value to character.
protected abstract Model	cloneTo(Model model, BrwsrCtx ctx) Re-binds the model object to new browser context.
<T> void	copyJSON(BrwsrCtx context, Object[] src, Class<T> destType, T[] dest) Converts and array of raw JSON objects into an array of typed Java Model classes.
Proto	createProto(Object obj, BrwsrCtx context) Creates new proto-object for given Model class bound to provided context.
<T> T	extractValue(Class<T> type, Object val) Extracts value of specific type from given object.
protected abstract Object	getValue(Model model, int index) Obtains and returns value of a registered property.
int	hashPlus(Object o, int h) Cumulative hash function.
boolean	isSame(double a, double b) Compares two objects that can be converted to (floating point) numbers.
boolean	isSame(int a, int b) Compares two objects that can be converted to integers.
boolean	isSame(Object a, Object b) Compares two objects for being the same - e.g.
Number	numberValue(Object val) Converts the value to number.
protected abstract void	onChange(Model model, int index) Called when a registered property changes its value.
protected void	onMessage(Model model, int index, int type, Object data) Called to report results of asynchronous over-the-wire communication.
protected void	onMessage(Model model, int index, int type, Object data, Object[] params) Called to report results of asynchronous over-the-wire communication.
protected abstract Proto	protoFor(Object object) Finds out if there is an associated proto-object for given object.
protected abstract Model	read(BrwsrCtx c, Object json) Reads raw JSON data and converts them to our model class.
protected void	registerFunction(String name, int index) Registers function of given name at given index.
protected void	registerProperty(String name, int index, boolean readOnly) Registers property for the type.
protected void	registerProperty(String name, int index, boolean readOnly, boolean constant) Registers property for the type.
<T> void	replaceValue(Collection<? super T> arr, Class<T> type, Object value) Special dealing with array & List values.
protected abstract void	setValue(Model model, int index, Object value) Sets value of a registered property to new value.
String	stringValue(Object val) Converts the value to string.
String	toJSON(Object obj) Converts an object to its JSON value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Type

protected Type(Class<? extends Model> clazz,
               Class<?> modelFor,
               int properties,
               int functions)

Constructor for subclasses generated by the annotation processor associated with Model annotation.

Parameters:

clazz - the generated model class

modelFor - the original class annotated by the Model annotation.

properties - number of properties the class has

functions - number of functions the class has

Method Detail

registerProperty

protected final void registerProperty(String name,
                                      int index,
                                      boolean readOnly)

Registers property for the type. It is expected each index is initialized only once.

Parameters:

name - name of the property

index - index of the property

readOnly - is the property read only?

registerProperty

protected final void registerProperty(String name,
                                      int index,
                                      boolean readOnly,
                                      boolean constant)

Registers property for the type. It is expected each index is initialized only once. The difference between readOnly and constant is: The constant value is assigned only at the beginning and never changed then - like the non-mutable property. On the other hand, a readOnly property can change its value, but not via a setter - just like ComputedProperty.

This method isn't synchronized. Synchronization is up to the caller.

Parameters:

name - name of the property

index - index of the property

readOnly - is the property read only?

constant - is the property assigned once and never changed again?

Since:

1.3

registerFunction

protected final void registerFunction(String name,
                                      int index)

Registers function of given name at given index.

Parameters:

name - name of the function

index - name of the type

createProto

public Proto createProto(Object obj,
                         BrwsrCtx context)

Creates new proto-object for given Model class bound to provided context.

Parameters:

obj - instance of appropriate Model class

context - the browser context

Returns:

new proto-object that the generated class can use for communication with the infrastructure

setValue

protected abstract void setValue(Model model,
                                 int index,
                                 Object value)

Sets value of a registered property to new value.

Parameters:

model - the instance of model class

index - index of the property used during registration

value - the value to set the property to

getValue

protected abstract Object getValue(Model model,
                                   int index)

Obtains and returns value of a registered property.

Parameters:

model - the instance of model class

index - index of the property used during registration

Returns:

current value of the property

call

protected abstract void call(Model model,
                             int index,
                             Object data,
                             Object event)
                      throws Exception

Invokes a Proto.Type.registerFunction(java.lang.String, int) registered function on given object.

Parameters:

model - the instance of model class

index - index of the property used during registration

data - the currently selected object the function is about to operate on

event - the event that triggered the event

Throws:

Exception - the method can throw exception which is then logged

cloneTo

protected abstract Model cloneTo(Model model,
                                 BrwsrCtx ctx)

Re-binds the model object to new browser context.

Parameters:

model - the instance of model class

ctx - browser context to clone the object to

Returns:

new instance of the model suitable for new context

read

protected abstract Model read(BrwsrCtx c,
                              Object json)

Reads raw JSON data and converts them to our model class.

Parameters:

c - the browser context to work in

json - raw JSON data to get values from

Returns:

new instance of model class filled by the data

onChange

protected abstract void onChange(Model model,
                                 int index)

Called when a registered property changes its value.

Parameters:

model - the object that has the property

index - the index of the property during registration

protoFor

protected abstract Proto protoFor(Object object)

Finds out if there is an associated proto-object for given object.

Parameters:

object - an object, presumably (but not necessarily) instance of Model class

Returns:

associated proto-object or null

onMessage

protected void onMessage(Model model,
                         int index,
                         int type,
                         Object data)

Called to report results of asynchronous over-the-wire communication. Result of calling Proto.wsOpen(int, java.lang.String, java.lang.Object) or Proto.loadJSON(int, java.lang.String, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object...).

Parameters:

model - the instance of the model class

index - index used during initiating the communication (via loadJSON or wsOpen calls)

type - type of the message: 0 - onOpen, 1 - onMessage, 2 - onError, 3 - onClose - not all messages are applicable to all communication protocols (JSON has only 1 and 2).

data - null or string, number or a Model class obtained to the server as a response

onMessage

protected void onMessage(Model model,
                         int index,
                         int type,
                         Object data,
                         Object[] params)

Called to report results of asynchronous over-the-wire communication. Result of calling Proto.wsOpen(int, java.lang.String, java.lang.Object) or Proto.loadJSON(int, java.lang.String, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object...).

Parameters:

model - the instance of the model class

index - index used during initiating the communication (via loadJSON or wsOpen calls)

type - type of the message: 0 - onOpen, 1 - onMessage, 2 - onError, 3 - onClose - not all messages are applicable to all communication protocols (JSON has only 1 and 2).

data - null or string, number or a Model class obtained to the server as a response

params - extra parameters as passed for example to Proto.loadJSON(int, java.lang.String, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object...) method

Since:

0.8.1

copyJSON

public <T> void copyJSON(BrwsrCtx context,
                         Object[] src,
                         Class<T> destType,
                         T[] dest)

Converts and array of raw JSON objects into an array of typed Java Model classes.

Type Parameters:

T - the type of the destination array

Parameters:

context - browser context to use

src - array of raw JSON objects

destType - type of the individual array elements

dest - array to be filled with read type instances

isSame

public final boolean isSame(int a,
                            int b)

Compares two objects that can be converted to integers.

Parameters:

a - first value

b - second value

Returns:

true if they are the same

isSame

public final boolean isSame(double a,
                            double b)

Compares two objects that can be converted to (floating point) numbers.

Parameters:

a - first value

b - second value

Returns:

true if they are the same

isSame

public final boolean isSame(Object a,
                            Object b)

Compares two objects for being the same - e.g. either == or equals.

Parameters:

a - first value

b - second value

Returns:

true if they are equals

hashPlus

public final int hashPlus(Object o,
                          int h)

Cumulative hash function. Adds hashcode of the object to the previous value.

Parameters:

o - the object (or null)

h - the previous value of the hash

Returns:

new hash - the old one xor the object's one

toJSON

public final String toJSON(Object obj)

Converts an object to its JSON value.

Parameters:

obj - the object to convert

Returns:

JSON representation of the object

stringValue

public final String stringValue(Object val)

Converts the value to string.

Parameters:

val - the value

Returns:

the converted value

numberValue

public final Number numberValue(Object val)

Converts the value to number.

Parameters:

val - the value

Returns:

the converted value

charValue

public final Character charValue(Object val)

Converts the value to character.

Parameters:

val - the value

Returns:

the converted value

boolValue

public final Boolean boolValue(Object val)

Converts the value to boolean.

Parameters:

val - the value

Returns:

the converted value

extractValue

public final <T> T extractValue(Class<T> type,
                                Object val)

Extracts value of specific type from given object.

Type Parameters:

T - the type of object one is interested in

Parameters:

type - the type

val - the object to convert to type

Returns:

the converted value

replaceValue

public final <T> void replaceValue(Collection<? super T> arr,
                                   Class<T> type,
                                   Object value)

Special dealing with array & List values. This method takes the provided collection, empties it and fills it again with values extracted from value (which is supposed to be an array).

Type Parameters:

T - the type of list elements

Parameters:

arr - collection to fill with elements in value

type - the type of elements in the collection

value - array of elements to put into the collecition. If value is not an array it is wrapped into array with only element

Since:

1.0