org.zalando.guild.api.json.fields.java.model

Interface FieldPredicate

All Superinterfaces:

com.google.common.base.Predicate<List<String>>

public interface FieldPredicate
extends com.google.common.base.Predicate<List<String>>

The core abstraction for matching a hierarchy of fields. Based on this, a hierarchy of fields can be tested against a fields expression.

Since:

20.08.2015

Author:

Sean Patrick Floyd (sean.floyd@zalando.de)

Method Summary

Modifier and Type	Method and Description
boolean	apply(List<String> fieldHierarchy) Return true if the supplied field hierarchy should be rendered.

Methods inherited from interface com.google.common.base.Predicate

equals

Method Detail

apply

boolean apply(@Nonnull
              List<String> fieldHierarchy)

Return true if the supplied field hierarchy should be rendered. A list of strings represents a hierarchy of objects, where each element is the parent element of the next. E.g. a list ["foo", "bar", "baz"] would map to a JSON object hierarchy like this: {"foo":{"bar":{"baz":"some value"}}}. I.e. a FieldPredicate matching this list would cause the "baz" field to be rendered.

Implementations of this interface will not accept null values. They may throw IllegalArgumentException when confronted with empty lists.

Specified by:

apply in interface com.google.common.base.Predicate<List<String>>

Throws:

NullPointerException - if the supplied list is null or contains null values

IllegalArgumentException - if the supplied list is empty