org.boon.json.serializers.impl.AbstractCustomFieldSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of boon Show documentation

Simple opinionated Java for the novice to expert level Java Programmer. Low Ceremony. High Productivity. A real boon to Java to developers!

There is a newer version: 0.34

Show newest version

package org.boon.json.serializers.impl;

import org.boon.core.reflection.fields.FieldAccess;
import org.boon.json.serializers.CustomFieldSerializer;
import org.boon.json.serializers.JsonSerializerInternal;
import org.boon.primitive.CharBuf;

/**
 * Custom serializer for a specific field of a specific class. 

 * The field is identified by its name, not by its alias (specified by the annotation
 * {@link org.boon.json.annotations.SerializedName}).

 */
public abstract class AbstractCustomFieldSerializer implements CustomFieldSerializer {
	private final Class parentClass;
	private final String fieldName;

	/**
	 * Constructor of the serializer.
	 * @param parentClass Class containing the field to serialize.
	 * @param fieldName Name of the field to serialize.
	 */
	public AbstractCustomFieldSerializer(Class parentClass, String fieldName) {
		super();
		this.fieldName = fieldName;
		this.parentClass = parentClass;
	}

	@Override
	public boolean serializeField(JsonSerializerInternal serializer, Object parent, FieldAccess fieldAccess, CharBuf builder) {
		// It only check parent class equality, doesn't work with inheritance
		if (parentClass == parent.getClass() && fieldName.equals(fieldAccess.name())) {
			Object value = fieldAccess.getValue(parent);
			serialize(serializer, parent, fieldAccess, value, builder);
			return true;
		}
		return false;
	}

	/**
	 * This method has to be overloaded to specify how this field is serialized.

	 * For example:
	 * 
	 * 	 * {@code
	 * if (value != null) {
	 * 	builder.addJsonFieldName(fieldAcces.name());
	 * 	builder.addQuoted(value.toString());
	 * } else {
	 * 	builder.addJsonFieldName(fieldAcces.name());
	 * 	builder.addQuoted("N/A");
	 * }
	 * 
	 * @param serializer JsonSerializer to help serializing dates, arrays...
	 * @param parent Class containing the field.
	 * @param fieldAccess Field access.
	 * @param value Value of the field.
	 * @param builder Json builder.
	 */
	protected abstract void serialize(JsonSerializerInternal serializer, Object parent, FieldAccess fieldAccess, Object value,
			CharBuf builder);

}