Package com.restfb

Klasse DefaultJsonMapper

java.lang.Object

com.restfb.DefaultJsonMapper

Alle implementierten Schnittstellen:

JsonMapper

public class DefaultJsonMapper
extends Object
implements JsonMapper

Default implementation of a JSON-to-Java mapper.

Autor:

Mark Allen

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen com.restfb.JsonMapper

JsonMapper.JsonMappingCompleted

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DefaultJsonMapper()	Creates a JSON mapper which will throw FacebookJsonMappingException whenever an error occurs when mapping JSON data to Java objects.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected Set<String>	facebookFieldNamesWithMultipleMappings(List<ReflectionUtils.FieldWithAnnotation<Facebook>> fieldsWithAnnotation)	Finds any Facebook JSON fields that are mapped to more than 1 Java field.
protected String	getFacebookFieldName(ReflectionUtils.FieldWithAnnotation<Facebook> fieldWithAnnotation)	For a Java field annotated with the Facebook annotation, figure out what the corresponding Facebook JSON field name to map to it is.
protected void	invokeJsonMappingCompletedMethods(Object object)	Finds and invokes methods on object that are annotated with the @JsonMappingCompleted annotation.
protected void	logMultipleMappingFailedForField(String facebookFieldName, ReflectionUtils.FieldWithAnnotation<Facebook> fieldWithAnnotation, String json)	Dumps out a log message when one of a multiple-mapped Facebook field name JSON-to-Java mapping operation fails.
void	setFacebookClient(FacebookClient facebookClient)	adds a FacebookClient implementation to the mapper.
<T> List<T>	toJavaList(String json, Class<T> type)	Given a JSON string, create and return a new instance of a corresponding Java List which contains elements of type type.
<T> T	toJavaObject(String json, Class<T> type)	Given a JSON string, create and return a new instance of a corresponding Java object of type type.
protected Object	toJavaType(ReflectionUtils.FieldWithAnnotation<Facebook> fieldWithAnnotation, JsonObject jsonObject, String facebookFieldName)	Extracts JSON data for a field according to its Facebook annotation and returns it converted to the proper Java type.
String	toJson(Object object)	Given a Java object, create and return a JSON string that represents it.
String	toJson(Object object, boolean ignoreNullValuedProperties)	Given a Java object, create and return a JSON string that represents it.
protected JsonValue	toJsonInternal(Object object, boolean ignoreNullValuedProperties)	Recursively marshal the given object to JSON.
protected <T> T	toPrimitiveJavaType(String json, Class<T> type)	Given a json value of something like MyValue or 123 , return a representation of that value of type type.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

DefaultJsonMapper

public DefaultJsonMapper()

Creates a JSON mapper which will throw FacebookJsonMappingException whenever an error occurs when mapping JSON data to Java objects.

Methodendetails

setFacebookClient

public void setFacebookClient(FacebookClient facebookClient)

Beschreibung aus Schnittstelle kopiert: JsonMapper

adds a FacebookClient implementation to the mapper. This is especially useful for mapping json to Connection objects that need the client itself.

Angegeben von:

setFacebookClient in Schnittstelle JsonMapper

Parameter:

facebookClient - that is used for Connection objects

toJavaList

public <T> List<T> toJavaList(String json,
 Class<T> type)

Beschreibung aus Schnittstelle kopiert: JsonMapper

Given a JSON string, create and return a new instance of a corresponding Java List which contains elements of type type.

The Java type must have a no-argument constructor.

Angegeben von:

toJavaList in Schnittstelle JsonMapper

Typparameter:

T - Java type to map to for each element of the list.

Parameter:

json - The JSON to be mapped to a Java type.

type - Java type token.

Gibt zurück:

A Java object (of type List which contains elements of type type) representation of the JSON input.

toJavaObject

public <T> T toJavaObject(String json,
 Class<T> type)

Beschreibung aus Schnittstelle kopiert: JsonMapper

Given a JSON string, create and return a new instance of a corresponding Java object of type type.

The Java type must have a no-argument constructor.

Angegeben von:

toJavaObject in Schnittstelle JsonMapper

Typparameter:

T - Java type to map to.

Parameter:

json - The JSON to be mapped to a Java type.

type - Java type token.

Gibt zurück:

A Java object (of type type) representation of the JSON input.

invokeJsonMappingCompletedMethods

protected void invokeJsonMappingCompletedMethods(Object object)
                                          throws IllegalAccessException,
InvocationTargetException

Finds and invokes methods on object that are annotated with the @JsonMappingCompleted annotation.

This will even work on private methods.

Parameter:

object - The object on which to invoke the method.

Löst aus:

IllegalAccessException - If unable to invoke the method.

InvocationTargetException - If unable to invoke the method.

logMultipleMappingFailedForField

protected void logMultipleMappingFailedForField(String facebookFieldName,
 ReflectionUtils.FieldWithAnnotation<Facebook> fieldWithAnnotation,
 String json)

Dumps out a log message when one of a multiple-mapped Facebook field name JSON-to-Java mapping operation fails.

Parameter:

facebookFieldName - The Facebook field name.

fieldWithAnnotation - The Java field to map to and its annotation.

json - The JSON that failed to map to the Java field.

getFacebookFieldName

protected String getFacebookFieldName(ReflectionUtils.FieldWithAnnotation<Facebook> fieldWithAnnotation)

For a Java field annotated with the Facebook annotation, figure out what the corresponding Facebook JSON field name to map to it is.

Parameter:

fieldWithAnnotation - A Java field annotated with the Facebook annotation.

Gibt zurück:

The Facebook JSON field name that should be mapped to this Java field.

facebookFieldNamesWithMultipleMappings

protected Set<String> facebookFieldNamesWithMultipleMappings(List<ReflectionUtils.FieldWithAnnotation<Facebook>> fieldsWithAnnotation)

Finds any Facebook JSON fields that are mapped to more than 1 Java field.

Parameter:

fieldsWithAnnotation - Java fields annotated with the Facebook annotation.

Gibt zurück:

Any Facebook JSON fields that are mapped to more than 1 Java field.

toJson

public String toJson(Object object)

Beschreibung aus Schnittstelle kopiert: JsonMapper

Given a Java object, create and return a JSON string that represents it.

The object's properties will be traversed recursively, allowing for arbitrarily complex JSON generation.

Angegeben von:

toJson in Schnittstelle JsonMapper

Parameter:

object - The Java object to map to JSON. Can be a Javabean, List, or Map.

Gibt zurück:

A JSON string.

toJson

public String toJson(Object object,
 boolean ignoreNullValuedProperties)

Beschreibung aus Schnittstelle kopiert: JsonMapper

Given a Java object, create and return a JSON string that represents it.

The object's properties will be traversed recursively, allowing for arbitrarily complex JSON generation.

Angegeben von:

toJson in Schnittstelle JsonMapper

Parameter:

object - The Java object to map to JSON. Can be a Javabean, List, or Map.

ignoreNullValuedProperties - If true, no Javabean properties with null values will be included in the generated JSON.

Gibt zurück:

A JSON string.

toJsonInternal

protected JsonValue toJsonInternal(Object object,
 boolean ignoreNullValuedProperties)

Recursively marshal the given object to JSON.

Used by toJson(Object).

Parameter:

object - The object to marshal.

ignoreNullValuedProperties - If this is true, no Javabean properties with null values will be included in the generated JSON.

Gibt zurück:

JSON representation of the given object.

Löst aus:

FacebookJsonMappingException - If an error occurs while marshaling to JSON.

toPrimitiveJavaType

protected <T> T toPrimitiveJavaType(String json,
 Class<T> type)

Given a json value of something like MyValue or 123 , return a representation of that value of type type.

This is to support non-legal JSON served up by Facebook for API calls like Friends.get (example result: [222333,1240079]).

Typparameter:

T - The Java type to map to.

Parameter:

json - The non-legal JSON to map to the Java type.

type - Type token.

Gibt zurück:

Java representation of json.

Löst aus:

FacebookJsonMappingException - If an error occurs while mapping JSON to Java.

toJavaType

protected Object toJavaType(ReflectionUtils.FieldWithAnnotation<Facebook> fieldWithAnnotation,
 JsonObject jsonObject,
 String facebookFieldName)

Extracts JSON data for a field according to its Facebook annotation and returns it converted to the proper Java type.

Parameter:

fieldWithAnnotation - The field/annotation pair which specifies what Java type to convert to.

jsonObject - "Raw" JSON object to pull data from.

facebookFieldName - Specifies what JSON field to pull "raw" data from.

Gibt zurück:

A

Löst aus:

ParseException - If an error occurs while mapping JSON to Java.

FacebookJsonMappingException - If an error occurs while mapping JSON to Java.