Class GsonTester<T>
- java.lang.Object
- org.springframework.boot.test.json.AbstractJsonMarshalTester<T>
- org.springframework.boot.test.json.GsonTester<T>
- Type Parameters:
T- the type under test
public class GsonTester<T> extends AbstractJsonMarshalTester<T>
AssertJ based JSON tester backed by Gson. Usually instantiated viainitFields(Object, Gson), for example:public class ExampleObjectJsonTests { private GsonTester<ExampleObject> json; @Before public void setup() { Gson gson = new GsonBuilder().create(); GsonTester.initFields(this, gson); } @Test public void testWriteJson() throws IOException { ExampleObject object = //... assertThat(json.write(object)).isEqualToJson("expected.json"); } }SeeAbstractJsonMarshalTesterfor more details.- Since:
- 1.4.0
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.boot.test.json.AbstractJsonMarshalTester
AbstractJsonMarshalTester.FieldInitializer<M>
Constructor Summary
Constructors Modifier Constructor Description protectedGsonTester(com.google.gson.Gson gson)Create a new uninitializedGsonTesterinstance.GsonTester(Class<?> resourceLoadClass, org.springframework.core.ResolvableType type, com.google.gson.Gson gson)Create a newGsonTesterinstance.
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static voidinitFields(Object testInstance, com.google.gson.Gson gson)Utility method to initializeGsonTesterfields.static voidinitFields(Object testInstance, org.springframework.beans.factory.ObjectFactory<com.google.gson.Gson> gson)Utility method to initializeGsonTesterfields.protected TreadObject(Reader reader, org.springframework.core.ResolvableType type)Read from the specified reader to create an object of the specified type.protected StringwriteObject(T value, org.springframework.core.ResolvableType type)Write the specified object to a JSON string.Methods inherited from class org.springframework.boot.test.json.AbstractJsonMarshalTester
getResourceLoadClass, getType, initialize, parse, parse, parseObject, parseObject, read, read, read, read, read, readObject, readObject, readObject, readObject, readObject, readObject, write
Constructor Detail
GsonTester
protected GsonTester(com.google.gson.Gson gson)
Create a new uninitializedGsonTesterinstance.- Parameters:
gson- the Gson instance
GsonTester
public GsonTester(Class<?> resourceLoadClass, org.springframework.core.ResolvableType type, com.google.gson.Gson gson)
Create a newGsonTesterinstance.- Parameters:
resourceLoadClass- the source class used to load resourcestype- the type under testgson- the Gson instance- See Also:
initFields(Object, Gson)
Method Detail
writeObject
protected String writeObject(T value, org.springframework.core.ResolvableType type) throws IOException
Description copied from class:AbstractJsonMarshalTesterWrite the specified object to a JSON string.- Specified by:
writeObjectin classAbstractJsonMarshalTester<T>- Parameters:
value- the source value (nevernull)type- the resulting type (nevernull)- Returns:
- the JSON string
- Throws:
IOException- on write error
readObject
protected T readObject(Reader reader, org.springframework.core.ResolvableType type) throws IOException
Description copied from class:AbstractJsonMarshalTesterRead from the specified reader to create an object of the specified type.- Specified by:
readObjectin classAbstractJsonMarshalTester<T>- Parameters:
reader- the source reader (nevernull)type- the resulting type (nevernull)- Returns:
- the resulting object
- Throws:
IOException- on read error
initFields
public static void initFields(Object testInstance, com.google.gson.Gson gson)
Utility method to initializeGsonTesterfields. Seeclass-level documentationfor example usage.- Parameters:
testInstance- the test instancegson- the Gson instance
initFields
public static void initFields(Object testInstance, org.springframework.beans.factory.ObjectFactory<com.google.gson.Gson> gson)
Utility method to initializeGsonTesterfields. Seeclass-level documentationfor example usage.- Parameters:
testInstance- the test instancegson- an object factory to create the Gson instance