com.sdl.context.api.resolution

Interface Evidence

All Superinterfaces:

Iterable<EvidenceItem>

public interface Evidence
extends Iterable<EvidenceItem>

Evidence. Users of this interface can provide evidence to the context engine so that it can determine how to resolve the context.

Author:

Ben Middleton

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Returns true if the evidence contains an item with the specified key.
boolean	containsOrigin(String origin) Returns true if the evidence contains an evidence item of the specified origin (e.g.
EvidenceItem	get(String key) Returns the evidence item identified by the specified key (e.g.
Iterator<EvidenceItem>	iterator() Provides an iterator which returns all the EvidenceItems in the Evidence.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get

EvidenceItem get(String key)

Returns the evidence item identified by the specified key (e.g. "user-agent").

Parameters:

key - the key of the evidence item e.g. "user-agent"

Returns:

the evidence item

containsKey

boolean containsKey(String key)

Returns true if the evidence contains an item with the specified key.

Parameters:

key - the key of the evidence item e.g. "user-agent"

Returns:

true if the evidence contains the appropriate item

containsOrigin

boolean containsOrigin(String origin)

Returns true if the evidence contains an evidence item of the specified origin (e.g. "http", "context", "adf" etc).

Parameters:

origin - the origin (e.g. "http", "context", "adf" etc)

Returns:

true if the evidence contains an evidence item from the specified origin

iterator

Iterator<EvidenceItem> iterator()

Provides an iterator which returns all the EvidenceItems in the Evidence.

This iterator method (in conjunction with the Iterable interface) enables evidence items to be processed using a java for loop. for example:

 for (EvidenceItem evidenceItem : evidence) {
   String key = evidenceItem.getKey();
   Object value = evidenceItem.getValue();
 }
 

Specified by:

iterator in interface Iterable<EvidenceItem>

Returns:

an iterator which returns all the EvidenceItems in the Evidence