EntityMaps (uk.gov.gchq.gaffer:gaffer2 2.2.0 API)

All Superinterfaces:

Iterable<EntityMap>

All Known Implementing Classes:

SimpleEntityMaps
```
public interface EntityMaps
extends Iterable<EntityMap>
```
An EntityMaps object contains a number of EntityMap objects and can be used to represent the changes in an EntityMap over time or to track the entities of a graph over some other metric.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`add(EntityMap entityMap)`	Add a new `EntityMap`.
`List<EntityMap>`	`asList()`	Get a representation of the current EntityMaps object as a `List`.
`default boolean`	`empty()`	Return `true` if this EntityMaps object is empty, otherwise `false`.
`default EntityMap`	`get(int n)`	Retrieve the nth `EntityMap`.
`default Iterator<EntityMap>`	`iterator()`
`default String`	`prettyPrint()`	Print the `EntityMap` object in an easily readable format.
`default int`	`size()`	Return the number of `EntityMap` present in the entityMaps object.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - add
```
default void add(EntityMap entityMap)
```
    Add a new EntityMap.
    
    Parameters:
    
    entityMap - the entityMap to add
  - get
```
default EntityMap get(int n)
```
    Retrieve the nth EntityMap.
    
    Parameters:
    
    n - the index of the adjacency map to retrieve
    
    Returns:
    
    the nth entityMap
  - size
```
default int size()
```
    Return the number of EntityMap present in the entityMaps object.
    Depending on the context, this could refer to the number of hops present, or the number of timesteps etc.
    
    Returns:
    
    the size of the entityMaps object
  - empty
```
default boolean empty()
```
    Return true if this EntityMaps object is empty, otherwise false.
    
    Returns:
    
    the empty state of this object
  - prettyPrint
```
default String prettyPrint()
```
    Print the EntityMap object in an easily readable format.
    
    Returns:
    
    a prettily printed String representation of the entityMap object.
  - asList
```
List<EntityMap> asList()
```
    Get a representation of the current EntityMaps object as a List.
    
    Returns:
    
    a List representation of the current entityMaps object
  - iterator
```
default Iterator<EntityMap> iterator()
```
    Specified by:
    
    iterator in interface Iterable<EntityMap>