org.assertj.neo4j.api

Class RelationshipAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<A,T>

org.assertj.neo4j.api.PropertyContainerAssert<RelationshipAssert,org.neo4j.graphdb.Relationship>

org.assertj.neo4j.api.RelationshipAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<RelationshipAssert,org.neo4j.graphdb.Relationship>, org.assertj.core.api.Descriptable<RelationshipAssert>, org.assertj.core.api.ExtensionPoints<RelationshipAssert,org.neo4j.graphdb.Relationship>

public class RelationshipAssert
extends PropertyContainerAssert<RelationshipAssert,org.neo4j.graphdb.Relationship>

Assertions for Neo4J Relationship

Author:

Florent Biville

Field Summary

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

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelationshipAssert(org.neo4j.graphdb.Relationship actual)

Method Summary

Modifier and Type	Method and Description
RelationshipAssert	doesNotEndWithNode(org.neo4j.graphdb.Node node)
RelationshipAssert	doesNotHaveType(org.neo4j.graphdb.RelationshipType relationshipType) Verifies that the actual Relationship does not have the given type
RelationshipAssert	doesNotHaveType(String relationshipTypeName) Verifies that the actual Relationship does not have the given type name
RelationshipAssert	doesNotStartWithNode(org.neo4j.graphdb.Node node) Verifies that the actual Relationship does not start with the given node
RelationshipAssert	endsWithNode(org.neo4j.graphdb.Node node) Verifies that the actual Relationship ends with the given node
org.neo4j.graphdb.Relationship	getActual()
RelationshipAssert	hasType(org.neo4j.graphdb.RelationshipType relationshipType) Verifies that the actual Relationship has the given type
RelationshipAssert	hasType(String relationshipTypeName) Verifies that the actual Relationship has the given type name
RelationshipAssert	startsOrEndsWithNode(org.neo4j.graphdb.Node node) Verifies that the actual Relationship either starts or ends with the given node
RelationshipAssert	startsWithNode(org.neo4j.graphdb.Node node) Verifies that the actual Relationship starts with the given node

Methods inherited from class org.assertj.neo4j.api.PropertyContainerAssert

doesNotHaveProperty, doesNotHavePropertyKey, hasProperty, hasPropertyKey

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

as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasToString, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, overridingErrorMessage, satisfies, setCustomRepresentation, throwAssertionError, usingComparator, usingDefaultComparator, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationshipAssert

protected RelationshipAssert(org.neo4j.graphdb.Relationship actual)

Method Detail

getActual

public org.neo4j.graphdb.Relationship getActual()

Overrides:

getActual in class PropertyContainerAssert<RelationshipAssert,org.neo4j.graphdb.Relationship>

startsWithNode

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

Verifies that the actual Relationship starts with the given node

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...] creation of homerNode, doughnutNode
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 
 assertThat(love).startsWithNode(homerNode);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

node - the expected start node of the actual Relationship

Returns:

this RelationshipAssert for assertions chaining

Throws:

IllegalArgumentException - if node is null.

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

doesNotStartWithNode

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

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

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...] creation of homerNode, doughnutNode
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));

 assertThat(love).doesNotStartWithNode(healthyPersonNode);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

node - the expected start node of the actual Relationship

Returns:

this RelationshipAssert for assertions chaining

Throws:

IllegalArgumentException - if node is null.

AssertionError - if the actual Relationship starts with the given node

endsWithNode

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

Verifies that the actual Relationship ends with the given node

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...] creation of homerNode, doughnutNode
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 
 assertThat(love).endsWithNode(doughnutNode);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

node - the expected end node of the actual Relationship

Returns:

this RelationshipAssert for assertions chaining

Throws:

IllegalArgumentException - if node is null.

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

doesNotEndWithNode

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

startsOrEndsWithNode

public RelationshipAssert startsOrEndsWithNode(org.neo4j.graphdb.Node node)

Verifies that the actual Relationship either starts or ends with the given node

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...] creation of homerNode, doughnutNode
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 
 assertThat(love).startsOrEndsWithNode(homerNode);
 assertThat(love).startsOrEndsWithNode(doughnutNode);
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

node - the expected start or end node of the actual Relationship

Returns:

this RelationshipAssert for assertions chaining

Throws:

IllegalArgumentException - if node is null.

AssertionError - if the actual Relationship does not start neither end with the given node

hasType

public RelationshipAssert hasType(org.neo4j.graphdb.RelationshipType relationshipType)

Verifies that the actual Relationship has the given type

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...] creation of homerNode, doughnutNode
 RelationshipType loveType = DynamicRelationshipType.withName("LOVES");
 Relationship love = homerNode.createRelationshipTo(doughnutNode, loveType);
 
 assertThat(love).hasType(loveType);
 

If the relationshipType is null, an IllegalArgumentException is thrown.

Parameters:

relationshipType - a Relationship type

Returns:

this RelationshipAssert for assertions chaining

Throws:

IllegalArgumentException - if relationshipType is null.

AssertionError - if the actual Relationship does not have the given type

hasType

public RelationshipAssert hasType(String relationshipTypeName)

Verifies that the actual Relationship has the given type name

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...] creation of homerNode, doughnutNode
 RelationshipType loveType = DynamicRelationshipType.withName("LOVES");
 Relationship love = homerNode.createRelationshipTo(doughnutNode, loveType);
 
 assertThat(love).hasType("LOVES");
 

If the relationshipTypeName is null, an IllegalArgumentException is thrown.

Parameters:

relationshipTypeName - a Relationship type name

Returns:

this RelationshipAssert for assertions chaining

Throws:

IllegalArgumentException - if relationshipTypeName is null.

AssertionError - if the actual Relationship does not have the given type name

doesNotHaveType

public RelationshipAssert doesNotHaveType(org.neo4j.graphdb.RelationshipType relationshipType)

Verifies that the actual Relationship does not have the given type

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...] creation of homerNode, doughnutNode
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 
 assertThat(love).doesNotHaveType(DynamicRelationshipType.withName("HATES"));
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

relationshipType - a Relationship type

Returns:

this RelationshipAssert for assertions chaining

Throws:

IllegalArgumentException - if relationshipType is null.

AssertionError - if the actual Relationship has the given type

doesNotHaveType

public RelationshipAssert doesNotHaveType(String relationshipTypeName)

Verifies that the actual Relationship does not have the given type name

Example:

 GraphDatabaseService graph = new TestGraphDatabaseFactory().newImpermanentDatabase();
 // [...] creation of homerNode, doughnutNode
 Relationship love = homerNode.createRelationshipTo(doughnutNode, DynamicRelationshipType.withName("LOVES"));
 
 assertThat(love).doesNotHaveType("HATES");
 

If the node is null, an IllegalArgumentException is thrown.

Parameters:

relationshipTypeName - a Relationship type

Returns:

this RelationshipAssert for assertions chaining

Throws:

IllegalArgumentException - if relationshipTypeName is null.

AssertionError - if the actual Relationship has the given type