Interface JsonReader.ClassFactory

All Known Implementing Classes:

ArrayFactory, CharacterPrimArrayFactory, CollectionFactory, ConvertableFactory, EmptyEnumerationFactory, EmptyIteratorFactory, EmptyListFactory, EmptyListIteratorFactory, EmptyMapFactory, EmptyNavigableMapFactory, EmptyNavigableSetFactory, EmptySetFactory, EnumClassFactory, ImmutableListFactory, ImmutableSetFactory, MapFactory, RecordFactory, SealableListFactory, SealableMapFactory, SealableNavigableMapFactory, SealableNavigableSetFactory, SealableSetFactory, StackTraceElementFactory, ThrowableFactory

Enclosing class:

JsonReader

public static interface JsonReader.ClassFactory

Subclass this interface and create a class that will return a new instance of the passed in Class (c). Your factory subclass will be called when json-io encounters an instance of (c) which you register with JsonReader.assignInstantiator(). Use the passed in JsonObject o which is a JsonObject to source values for the construction of your class.

Author:

John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

License

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Method Summary

Modifier and Type	Method	Description
default void	gatherRemainingValues(Resolver resolver, JsonObject jObj, List<Object> arguments, Set<String> excludedFields)
default boolean	isObjectFinal()
default Object	newInstance(Class<?> c, JsonObject jObj, Resolver resolver)	Implement this method to return a new instance of the passed in Class.

Method Details

newInstance

default Object newInstance(Class<?> c,
 JsonObject jObj,
 Resolver resolver)

Implement this method to return a new instance of the passed in Class. Use the passed in JsonObject to supply values to the construction of the object.

Parameters:

c - Class of the object that needs to be created

jObj - JsonObject (if primitive type do jObj.getPrimitiveValue();

resolver - Resolve instance that has references to ID Map, Converter, ReadOptions

Returns:

a new instance of C. If you completely fill the new instance using the value(s) from object, and no further work is needed for construction, then override the isObjectFinal() method below and return true.

isObjectFinal

default boolean isObjectFinal()

Returns:

true if this object is instantiated and completely filled using the contents from the Object [a JsonObject or value]. In this case, no further processing will be performed on the instance. If the object has sub-objects (complex fields), then return false so that the JsonReader will continue on filling out the remaining portion of the object.

gatherRemainingValues

default void gatherRemainingValues(Resolver resolver,
 JsonObject jObj,
 List<Object> arguments,
 Set<String> excludedFields)