com.faunadb.client.types

Class Field<T>

java.lang.Object

com.faunadb.client.types.Field<T>

public final class Field<T>
extends java.lang.Object

A field extractor for a FaunaDB Value.

The field extractor can be used to extract field's values from key/value maps or collections returned by FaunaDB.

Example:

 Field<String> userNameField = Field.at("data", "name").to(String.class);
 Value result = client.query(getUser).get();
 String name = result.get(userNameField);
 

See Also:

Value

Method Summary

Modifier and Type	Method and Description
static <T> Field<T>	as(java.lang.Class<T> clazz) Creates a field that converts its underyling value to the Class provided.
static <T> Field<T>	as(Codec<T> codec) Creates a field that converts its underlying value using the Codec provided.
static <A> Field<java.util.List<A>>	asListOf(Field<A> field) Assuming the Value instance is a collection, creates a field extractor that collects the Field provided for each element in the underlying collection.
static <A> Field<java.util.Map<java.lang.String,A>>	asMapOf(Field<A> field)
<A> Field<A>	at(Field<A> other) Creates a field extractor composed with another nested Field instance.
static Field<Value>	at(int... indexes) Creates a field that extracts the underlying value from the indexes provided, assuming the Value instance is a collection or nested collections.
static Field<Value>	at(java.lang.String... keys) Creates a field that extracts the underlying value from the path provided, assuming the Value instance is a key/value map.
<A> Field<java.util.List<A>>	collect(Field<A> field) Assuming the Value instance is a collection, creates a field extractor that collects the Field provided for each element in the underlying collection.
boolean	equals(java.lang.Object other)
int	hashCode()
<A> Field<A>	to(java.lang.Class<A> type) Creates a field extractor that converts its value to the class provided.
<A> Field<A>	to(Codec<A> codec) Creates a field extractor that converts its value using the codec provided.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

at

public static Field<Value> at(java.lang.String... keys)

Creates a field that extracts the underlying value from the path provided, assuming the Value instance is a key/value map.

Parameters:

keys - the path to the desired field

Returns:

a new Field instance

See Also:

Field, Value

at

public static Field<Value> at(int... indexes)

Creates a field that extracts the underlying value from the indexes provided, assuming the Value instance is a collection or nested collections.

Parameters:

indexes - the path to the desired field

Returns:

a new Field instance

as

public static <T> Field<T> as(Codec<T> codec)

Creates a field that converts its underlying value using the Codec provided.

Type Parameters:

T - the desired final type

Parameters:

codec - Codec used to convert the field's value

Returns:

a new Field instance

as

public static <T> Field<T> as(java.lang.Class<T> clazz)

Creates a field that converts its underyling value to the Class provided.

Type Parameters:

T - the desired final type

Parameters:

clazz - the desired class type

Returns:

a new Field instance

asListOf

public static <A> Field<java.util.List<A>> asListOf(Field<A> field)

Assuming the Value instance is a collection, creates a field extractor that collects the Field provided for each element in the underlying collection.

Type Parameters:

A - the desired final type for each collection element

Parameters:

field - the Field to be extracted from each collection element

Returns:

a new Field instance

asMapOf

public static <A> Field<java.util.Map<java.lang.String,A>> asMapOf(Field<A> field)

at

public <A> Field<A> at(Field<A> other)

Creates a field extractor composed with another nested Field instance.

Type Parameters:

A - the desired final type

Parameters:

other - a nested Field to compose with

Returns:

a new Field instance

to

public <A> Field<A> to(Codec<A> codec)

Creates a field extractor that converts its value using the codec provided.

Type Parameters:

A - the desired final type

Parameters:

codec - the Codec to be used to convert the field's underlying value

Returns:

a new Field instance

to

public <A> Field<A> to(java.lang.Class<A> type)

Creates a field extractor that converts its value to the class provided.

Type Parameters:

A - the desired final type

Parameters:

type - the class to be used to convert the field's value

Returns:

a new Field instance

collect

public <A> Field<java.util.List<A>> collect(Field<A> field)

Assuming the Value instance is a collection, creates a field extractor that collects the Field provided for each element in the underlying collection.

Type Parameters:

A - the desired final type for each collection element

Parameters:

field - the Field to be extracted from each collection element

Returns:

a new Field instance

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object