AdjacencyMaps (uk.gov.gchq.gaffer:gaffer2 2.3.1 API)

All Superinterfaces:

Iterable<AdjacencyMap>

All Known Implementing Classes:

PrunedAdjacencyMaps, SimpleAdjacencyMaps
```
public interface AdjacencyMaps
extends Iterable<AdjacencyMap>
```
An AdjacencyMaps object contains a number of AdjacencyMap objects and can be used to represent the changes in an AdjacencyMap over time or to track the adjacency components 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(AdjacencyMap adjacencyMap)`	Add a new `AdjacencyMap`.
`List<AdjacencyMap>`	`asList()`	Get a representation of the current AdjacencyMaps object as a `List`.
`default boolean`	`empty()`	Return `true` if this AdjacencyMaps object is empty, otherwise `false`.
`default AdjacencyMap`	`get(int n)`	Retrieve the nth `AdjacencyMap`.
`default Iterator<AdjacencyMap>`	`iterator()`
`default String`	`prettyPrint()`	Print the `AdjacencyMaps` object in an easily readable format.
`default int`	`size()`	Return the number of `AdjacencyMap`s present in the AdjacencyMaps object.

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

- Method Detail
  - add
```
default void add(AdjacencyMap adjacencyMap)
```
    Add a new AdjacencyMap.
    
    Parameters:
    
    adjacencyMap - the AdjacencyMap to add
  - get
```
default AdjacencyMap get(int n)
```
    Retrieve the nth AdjacencyMap.
    
    Parameters:
    
    n - the index of the adjacency map to retrieve
    
    Returns:
    
    the nth AdjacencyMap
  - size
```
default int size()
```
    Return the number of AdjacencyMaps present in the AdjacencyMaps 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 AdjacencyMaps object
  - empty
```
default boolean empty()
```
    Return true if this AdjacencyMaps object is empty, otherwise false.
    
    Returns:
    
    the empty state of this object
  - prettyPrint
```
default String prettyPrint()
```
    Print the AdjacencyMaps object in an easily readable format.
    
    Returns:
    
    a prettily printed String representation of the AdjacencyMap object.
  - iterator
```
default Iterator<AdjacencyMap> iterator()
```
    Specified by:
    
    iterator in interface Iterable<AdjacencyMap>
  - asList
```
List<AdjacencyMap> asList()
```
    Get a representation of the current AdjacencyMaps object as a List.
    
    Returns:
    
    a List representation of the current AdjacencyMaps object