Package org.nustaq.kson

Class Kson

java.lang.Object

org.nustaq.kson.Kson

public class Kson
extends Object

a simple text <=> object serialization. More readable than JSon, less complication/error prone than Yaml.

Main use is configuration files. - Supports Pojo's only. - No multidimensional or nested arrays. - No untyped Arrays (e.g. Object x[] = new byte[] { 1, 2}) - Collections: Map and List. Use Generics to type collections (can omit type tags then) Example from fast-cast:

     public static ClusterConf readFrom( String filePath ) throws Exception {
       return (ClusterConf) new Kson()
              .map(PublisherConf.class, SubscriberConf.class, TopicConf.class, ClusterConf.class)
              .readObject(new File(filePath));
   }
 

Field Summary

Fields

Modifier and Type	Field	Description
static FSTConfiguration	conf

Constructor Summary

Constructors

Constructor	Description
Kson()
Kson(KsonTypeMapper mapper)

Method Summary

Modifier and Type	Method	Description
static Class	fumbleOutGenericKeyType(Field field)
static Class	fumbleOutGenericValueType(Field field)
KsonTypeMapper	getMapper()
boolean	isSupportJSon()
static void	main(String[] args)
Kson	map(Class... c)	map to simple name
Kson	map(String name, Class c)
Object	readObject(File file)
Object	readObject(File file, Class type)
Object	readObject(File file, String type)
Object	readObject(InputStream stream, String encoding, String expectedType)
Object	readObject(String dson)
Object	readObject(String dsonOrJSon, String expectedType)
Object	readObject(String dsonOrJSon, String expectedType, KsonArgTypesResolver resolve)
Kson	supportJSon(boolean supportJSon)
String	writeJSonObject(Object o, boolean tagTopLevel)
String	writeObject(Object o)
String	writeObject(Object o, boolean tagTopLevel)
String	writePlainJSonObject(Object o)

Methods inherited from class java.lang.Object

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

Field Details

conf

public static FSTConfiguration conf

Constructor Details

Kson

public Kson(KsonTypeMapper mapper)

Kson

public Kson()

Method Details

fumbleOutGenericKeyType

public static Class fumbleOutGenericKeyType(Field field)

fumbleOutGenericValueType

public static Class fumbleOutGenericValueType(Field field)

map

public Kson map(String name,
 Class c)

map

public Kson map(Class... c)

map to simple name

Parameters:

c -

Returns:

readObject

public Object readObject(String dson)
                  throws Exception

Throws:

Exception

readObject

public Object readObject(String dsonOrJSon,
 String expectedType,
 KsonArgTypesResolver resolve)
                  throws Exception

Throws:

Exception

readObject

public Object readObject(String dsonOrJSon,
 String expectedType)
                  throws Exception

Throws:

Exception

isSupportJSon

public boolean isSupportJSon()

supportJSon

public Kson supportJSon(boolean supportJSon)

readObject

public Object readObject(File file)
                  throws Exception

Throws:

Exception

readObject

public Object readObject(File file,
 Class type)
                  throws Exception

Throws:

Exception

readObject

public Object readObject(File file,
 String type)
                  throws Exception

Throws:

Exception

readObject

public Object readObject(InputStream stream,
 String encoding,
 String expectedType)
                  throws Exception

Throws:

Exception

writeObject

public String writeObject(Object o)
                   throws Exception

Throws:

Exception

writeObject

public String writeObject(Object o,
 boolean tagTopLevel)
                   throws Exception

Throws:

Exception

writeJSonObject

public String writeJSonObject(Object o,
 boolean tagTopLevel)
                       throws Exception

Throws:

Exception

writePlainJSonObject

public String writePlainJSonObject(Object o)
                            throws Exception

Throws:

Exception

getMapper

public KsonTypeMapper getMapper()

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception