xapi.model.api

Class ModelManifest

java.lang.Object

xapi.model.api.ModelManifest

public class ModelManifest
extends Object

This class is a manifest used to collect non-platform-specific metadata about all of the methods of a given model class. It will assemble and hold the field names of all the user-specified fields actually added to the model, including any annotations that specify behavior, such as being client-to-server/server-to-client only, whether the field should be encrypted during transmission, etc.

Author:

James X. Nelson (james@wetheinter.net, @james)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelManifest.MethodData

Constructor Summary

Constructors

Constructor and Description
ModelManifest(Class<? extends Model> cls)

Method Summary

Modifier and Type	Method and Description
ModelManifest.MethodData	addProperty(String methodName, xapi.annotation.model.GetterFor getter, xapi.annotation.model.SetterFor setter, xapi.annotation.model.DeleterFor deleter)
static ModelManifest	deserialize(CharIterator chars, PrimitiveSerializer primitives)
static ModelManifest	deserialize(String asString)
boolean	equals(Object obj)
xapi.annotation.model.SerializationStrategy	getClientToServerSerializationStrategy(String name)
ModelManifest.MethodData	getMethodData(String name)
ModelMethodType	getMethodType(String name)
Class<? extends Model>	getModelType()
xapi.annotation.model.PersistenceStrategy	getPersistenceStrategy(String name)
String[]	getPropertyNames()
xapi.annotation.model.SerializationStrategy	getServerToClientSerializationStrategy(String name)
String	getType()
Class<? extends xapi.util.api.ValidatesValue<?>>[]	getValidatorTypes(String name)
int	hashCode()
boolean	hasSeenMethod(String methodName)
boolean	isClientToServerEnabled(String name)
boolean	isClientToServerEncrypted(String name)
boolean	isIndexed(String propertyName) For now, we are setting all properties to indexed; we will map an annotation for this property in the future
boolean	isSerializationObfuscated(String name)
boolean	isServerToClientEnabled(String name)
boolean	isServerToClientEncrypted(String name)
static CharBuffer	serialize(CharBuffer out, ModelManifest manifest, PrimitiveSerializer primitives)
static String	serialize(ModelManifest manifest)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelManifest

public ModelManifest(Class<? extends Model> cls)

Method Detail

serialize

public static String serialize(ModelManifest manifest)

serialize

public static CharBuffer serialize(CharBuffer out,
                                   ModelManifest manifest,
                                   PrimitiveSerializer primitives)

deserialize

public static ModelManifest deserialize(String asString)

deserialize

public static ModelManifest deserialize(CharIterator chars,
                                        PrimitiveSerializer primitives)

addProperty

public ModelManifest.MethodData addProperty(String methodName,
                                            xapi.annotation.model.GetterFor getter,
                                            xapi.annotation.model.SetterFor setter,
                                            xapi.annotation.model.DeleterFor deleter)

getClientToServerSerializationStrategy

public xapi.annotation.model.SerializationStrategy getClientToServerSerializationStrategy(String name)

getServerToClientSerializationStrategy

public xapi.annotation.model.SerializationStrategy getServerToClientSerializationStrategy(String name)

isClientToServerEnabled

public boolean isClientToServerEnabled(String name)

isClientToServerEncrypted

public boolean isClientToServerEncrypted(String name)

isServerToClientEnabled

public boolean isServerToClientEnabled(String name)

isServerToClientEncrypted

public boolean isServerToClientEncrypted(String name)

isSerializationObfuscated

public boolean isSerializationObfuscated(String name)

getPersistenceStrategy

public xapi.annotation.model.PersistenceStrategy getPersistenceStrategy(String name)

getValidatorTypes

public Class<? extends xapi.util.api.ValidatesValue<?>>[] getValidatorTypes(String name)

getMethodData

public ModelManifest.MethodData getMethodData(String name)

getMethodType

public ModelMethodType getMethodType(String name)

hasSeenMethod

public boolean hasSeenMethod(String methodName)

getType

public String getType()

getModelType

public Class<? extends Model> getModelType()

getPropertyNames

public String[] getPropertyNames()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isIndexed

public boolean isIndexed(String propertyName)

For now, we are setting all properties to indexed; we will map an annotation for this property in the future