Module gg.xp.xivapi

Package gg.xp.xivapi.mappers.objects

Class ListFieldMapper<X>

java.lang.Object

gg.xp.xivapi.mappers.objects.ListFieldMapper<X>

Type Parameters:

X - The list type (e.g. List of String, not String)

All Implemented Interfaces:

FieldMapper<List<X>>

public class ListFieldMapper<X>
extends Object
implements FieldMapper<List<X>>

Mapper for list types.

This respects the OmitZeroes annotation, either on the method or the parameter type. If provided, then the list will not contain any elements for which their XivApiObject.isZero() method returns true. By default, this is when the row_id is zero. Note that using this with a non XivApiObject type will throw an exception.

Constructor Summary

Constructors

Constructor	Description
ListFieldMapper(Class<List<X>> cls, Method method, Type returnTypeFull, com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method	Description
void	buildQueryFields(QueryFieldsBuilder parent)
List<X>	getValue(com.fasterxml.jackson.databind.JsonNode current, XivApiContext context)

Methods inherited from class java.lang.Object

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

Constructor Details

ListFieldMapper

public ListFieldMapper(Class<List<X>> cls,
 Method method,
 Type returnTypeFull,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Details

getValue

public List<X> getValue(com.fasterxml.jackson.databind.JsonNode current,
 XivApiContext context)

Specified by:

getValue in interface FieldMapper<X>

buildQueryFields

public void buildQueryFields(QueryFieldsBuilder parent)

Specified by:

buildQueryFields in interface FieldMapper<X>