Developer Guide
Also available as:
loading table of contents...

Documenting Relationships

Processor Relationships are documented in much the same way that properties are - by calling the description method of a Relationship's builder:

public static final Relationship MY_RELATIONSHIP = new Relationship.Builder()
 .name("My Relationship")
 .description("This relationship is used only if the Processor fails to process the data.")