com.serjltt.moshi.adapters

Annotation Type ElementAt

@Documented
 @JsonQualifier
 @Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface ElementAt

Indicates that the annotated type/field is expected to be the element at the given index of a json array.

For example if a json object is:

   [
    {
      "some_field": "some_value",
      "other_field": "other_value"
    },
    {
      "some_field": "some_value_2",
      "other_field": "other_value_2"
    }
   ]
 

And the consumer only cares about the second element, if using retrofit a service method would look like:

    @GET("path/")
    @ElementAt(index = 1) Call<DataObject> getData();
 

The resulting response returned by response.body() will be an instance of DataObject with the respective values set.

To leverage from ElementAt ADAPTER_FACTORY must be added to your Moshi instance:

   Moshi moshi = new Moshi.Builder()
      .add(ElementAt.ADAPTER_FACTORY)
      .build();
 

Field Summary

Fields

Modifier and Type	Fields and Description
static com.squareup.moshi.JsonAdapter.Factory	ADAPTER_FACTORY Builds an adapter that can process a types annotated with ElementAt.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	index Represents the index location at which the element will be expected to be.

Field Detail

ADAPTER_FACTORY

public static final com.squareup.moshi.JsonAdapter.Factory ADAPTER_FACTORY

Builds an adapter that can process a types annotated with ElementAt.

Element Detail

index

public abstract int index

Represents the index location at which the element will be expected to be. If the size of the array will be less then the provided index, the companion adapter will return null.