org.assertj.neo4j.api

Class PathAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<SELF,ACTUAL>

org.assertj.core.api.AbstractIterableAssert<SELF,ACTUAL,ELEMENT,ELEMENT_ASSERT>

org.assertj.core.api.FactoryBasedNavigableIterableAssert<org.assertj.core.api.IterableAssert<ELEMENT>,Iterable<? extends ELEMENT>,ELEMENT,org.assertj.core.api.ObjectAssert<ELEMENT>>

org.assertj.core.api.IterableAssert<org.neo4j.graphdb.PropertyContainer>

org.assertj.neo4j.api.PathAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<org.assertj.core.api.IterableAssert<org.neo4j.graphdb.PropertyContainer>,Iterable<? extends org.neo4j.graphdb.PropertyContainer>>, org.assertj.core.api.Descriptable<org.assertj.core.api.IterableAssert<org.neo4j.graphdb.PropertyContainer>>, org.assertj.core.api.EnumerableAssert<org.assertj.core.api.IterableAssert<org.neo4j.graphdb.PropertyContainer>,org.neo4j.graphdb.PropertyContainer>, org.assertj.core.api.ExtensionPoints<org.assertj.core.api.IterableAssert<org.neo4j.graphdb.PropertyContainer>,Iterable<? extends org.neo4j.graphdb.PropertyContainer>>, org.assertj.core.api.ObjectEnumerableAssert<org.assertj.core.api.IterableAssert<org.neo4j.graphdb.PropertyContainer>,org.neo4j.graphdb.PropertyContainer>

public class PathAssert
extends org.assertj.core.api.IterableAssert<org.neo4j.graphdb.PropertyContainer>

Assertions for Neo4J Path

Author:

Florent Biville

Field Summary

Fields inherited from class org.assertj.core.api.AbstractIterableAssert

iterables

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PathAssert(org.neo4j.graphdb.Path actual)

Method Summary

Modifier and Type	Method and Description
PathAssert	doesNotEndWithNode(org.neo4j.graphdb.Node node) Verifies that the given node is not the last one of the actual Path
PathAssert	doesNotEndWithRelationship(org.neo4j.graphdb.Relationship relationship) Verifies that the given relationship is not the last one of the actual Path
PathAssert	doesNotStartWithNode(org.neo4j.graphdb.Node node) Verifies that the actual Path does not start with the given node
PathAssert	endsWithNode(org.neo4j.graphdb.Node node) Verifies that the actual Path ends with the given node
PathAssert	endsWithRelationship(org.neo4j.graphdb.Relationship relationship) Verifies that the given relationship is the last one of the actual Path
org.neo4j.graphdb.Path	getActual()
PathAssert	hasLength(int length) Verifies that the path length equals the given one
PathAssert	startsWithNode(org.neo4j.graphdb.Node node) Verifies that the actual Path starts with the given node

Methods inherited from class org.assertj.core.api.IterableAssert

contains, containsExactly, containsExactlyInAnyOrder, containsOnly, containsOnlyOnce, containsSequence, containsSubsequence, doesNotContain, doesNotContainSequence, doesNotContainSubsequence, endsWith, isEqualTo, isExactlyInstanceOf, isInstanceOf, isInstanceOfAny, isNotExactlyInstanceOf, isNotInstanceOf, isNotInstanceOfAny, isNotOfAnyClassIn, isNotSameAs, isOfAnyClassIn, isSameAs, isSubsetOf, startsWith

Methods inherited from class org.assertj.core.api.FactoryBasedNavigableIterableAssert

toAssert

Methods inherited from class org.assertj.core.api.AbstractIterableAssert

allMatch, allMatch, allSatisfy, anySatisfy, are, areAtLeast, areAtLeastOne, areAtMost, areExactly, areNot, as, as, containsAll, containsExactlyElementsOf, containsNull, containsOnlyElementsOf, containsSequence, containsSubsequence, describedAs, describedAs, doesNotContainAnyElementsOf, doesNotContainNull, doesNotContainSequence, doesNotContainSubsequence, doesNotHave, doesNotHaveDuplicates, doesNotHaveSameClassAs, doNotHave, element, extracting, extracting, extracting, extracting, extracting, extracting, extractingResultOf, extractingResultOf, filteredOn, filteredOn, filteredOn, filteredOn, filteredOnNull, first, flatExtracting, flatExtracting, flatExtracting, flatExtracting, flatExtracting, flatExtracting, has, hasAtLeastOneElementOfType, hasOnlyElementsOfType, hasOnlyElementsOfTypes, hasOnlyOneElementSatisfying, hasSameClassAs, hasSameElementsAs, hasSameSizeAs, hasSameSizeAs, hasSize, hasToString, have, haveAtLeast, haveAtLeastOne, haveAtMost, haveExactly, inBinary, inHexadecimal, is, isEmpty, isIn, isIn, isNot, isNotEmpty, isNotEqualTo, isNotIn, isNotIn, isNotNull, isNullOrEmpty, isSubsetOf, last, navigationDescription, newListAssertInstance, overridingErrorMessage, size, toLazyIterable, usingComparator, usingComparatorForElementFieldsWithNames, usingComparatorForElementFieldsWithType, usingComparisonStrategy, usingDefaultComparator, usingDefaultElementComparator, usingElementComparator, usingElementComparatorIgnoringFields, usingElementComparatorOnFields, usingFieldByFieldElementComparator, usingRecursiveFieldByFieldElementComparator, withFailMessage, withThreadDumpOnError

Methods inherited from class org.assertj.core.api.AbstractAssert

asList, asString, descriptionText, equals, failWithMessage, getWritableAssertionInfo, hashCode, isInstanceOfSatisfying, isNull, matches, matches, satisfies, setCustomRepresentation, throwAssertionError, withRepresentation

Methods inherited from class java.lang.Object

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

Constructor Detail

PathAssert

protected PathAssert(org.neo4j.graphdb.Path actual)

Method Detail

getActual

public org.neo4j.graphdb.Path getActual()

startsWithNode

public PathAssert startsWithNode(org.neo4j.graphdb.Node node)

Verifies that the actual Path starts with the given node

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...]
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 // PathExpander bellyExpander = [...]
 Path homerToDoughnutPath = GraphAlgoFactory.shortestPath(bellyExpander, 2).findSinglePath(homerNode, doughnutNode);
 
 assertThat(homerToDoughnutPath).startsWithNode(homerNode);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

node - the expected start node of the actual Path

Returns:

this PathAssert for assertions chaining

Throws:

IllegalArgumentException - if node is null.

AssertionError - if the actual Path does not start with the given node

doesNotStartWithNode

public PathAssert doesNotStartWithNode(org.neo4j.graphdb.Node node)

Verifies that the actual Path does not start with the given node

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...]
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 // [...]
 // PathExpander bellyExpander = [...]
 Path homerToDoughnutPath = GraphAlgoFactory.shortestPath(bellyExpander, 2).findSinglePath(homerNode, doughnutNode);

 assertThat(homerToDoughnutPath).doesNotStartWithNode(healthyPersonNode);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

node - the expected start node of the actual Path

Returns:

this PathAssert for assertions chaining

Throws:

IllegalArgumentException - if node is null.

AssertionError - if the actual Path starts with the given node

endsWithNode

public PathAssert endsWithNode(org.neo4j.graphdb.Node node)

Verifies that the actual Path ends with the given node

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...]
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 // PathExpander bellyExpander = [...]
 Path homerToDoughnutPath = GraphAlgoFactory.shortestPath(bellyExpander, 2).findSinglePath(homerNode, doughnutNode);
 
 assertThat(homerToDoughnutPath).endsWithNode(doughnutNode);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

node - the expected end node of the actual Path

Returns:

this PathAssert for assertions chaining

Throws:

IllegalArgumentException - if node is null.

AssertionError - if the actual Path does not end with the given node

doesNotEndWithNode

public PathAssert doesNotEndWithNode(org.neo4j.graphdb.Node node)

Verifies that the given node is not the last one of the actual Path

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...]
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 // PathExpander bellyExpander = [...]
 Path homerToDoughnutPath = GraphAlgoFactory.shortestPath(bellyExpander, 2).findSinglePath(homerNode, doughnutNode);

 assertThat(homerToDoughnutPath).doesNotEndWithNode(saladNode);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

node - the expected last node of the actual Path

Returns:

this PathAssert for assertions chaining

Throws:

IllegalArgumentException - if node is null.

AssertionError - if the actual Path ends with this node

endsWithRelationship

public PathAssert endsWithRelationship(org.neo4j.graphdb.Relationship relationship)

Verifies that the given relationship is the last one of the actual Path

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...]
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 // PathExpander bellyExpander = [...]
 Path homerToDoughnutPath = GraphAlgoFactory.shortestPath(bellyExpander, 2).findSinglePath(homerNode, doughnutNode);
 
 assertThat(homerToDoughnutPath).endsWithRelationship(love);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

relationship - the expected last relationship of the actual Path

Returns:

this PathAssert for assertions chaining

Throws:

IllegalArgumentException - if relationship is null.

AssertionError - if the actual Path does not contain this relationship last

doesNotEndWithRelationship

public PathAssert doesNotEndWithRelationship(org.neo4j.graphdb.Relationship relationship)

Verifies that the given relationship is not the last one of the actual Path

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...]
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 // PathExpander bellyExpander = [...]
 Path homerToDoughnutPath = GraphAlgoFactory.shortestPath(bellyExpander, 2).findSinglePath(homerNode, doughnutNode);

 assertThat(homerToDoughnutPath).doesNotEndWithRelationship(hate);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

relationship - the expected last relationship of the actual Path

Returns:

this PathAssert for assertions chaining

Throws:

IllegalArgumentException - if relationship is null.

AssertionError - if the actual Path ends with this relationship

hasLength

public PathAssert hasLength(int length)

Verifies that the path length equals the given one

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...]
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 // PathExpander bellyExpander = [...]
 Path homerToDoughnutPath = GraphAlgoFactory.shortestPath(bellyExpander, 2).findSinglePath(homerNode, doughnutNode);
 
 assertThat(homerToDoughnutPath).hasLength(1);
 

If the length is strictly negative, an IllegalArgumentException is thrown.

Parameters:

length - the expected length of the Path

Returns:

this PathAssert for assertions chaining

Throws:

IllegalArgumentException - if length is strictly negative.

AssertionError - if the actual Path has a different length