com.atlassian.confluence.api.nav

Interface Navigation.RelationFromNav

All Superinterfaces:

Navigation.Builder

All Known Subinterfaces:

Navigation.RelationNav

All Known Implementing Classes:

RelationNavImpl

Enclosing interface:

Navigation

public static interface Navigation.RelationFromNav
extends Navigation.Builder

A relation builder nav builder that only supports the FROM direction, this and the corresponding TO Nav allow the type system to prevent nonsensical URLs where the same direction is repeated. The FROM Nav builder returns the TO nav builders from methods where it makes sense to allow the TO direction, i.e. relation/{relName}/from/{sourceType}/{sourceId} supports a further to/{targetType} path to be appended but not an additional from/ path

Field Summary

Fields inherited from interface com.atlassian.confluence.api.nav.Navigation.Builder

NONE

Method Summary

Modifier and Type	Method and Description
Navigation.Builder	from()
Navigation.Builder	from(Class sourceClass)
Navigation.RelationToNav	from(Class sourceClass, String sourceId)
Navigation.RelationToNav	from(Reference<? extends Relatable> reference)

Methods inherited from interface com.atlassian.confluence.api.nav.Navigation.Builder

buildAbsolute, buildCanonicalAbsolute, buildRelative, buildRelativeWithContext

Method Detail

from

Navigation.Builder from()

Returns:

a terminal navigation builder with the "from" path appended to the existing path

from

Navigation.Builder from(Class sourceClass)

Returns:

a terminal navigation builder with the "from/{sourceType}" path appended to the existing path

from

Navigation.RelationToNav from(Reference<? extends Relatable> reference)

Returns:

a to navigation builder with the "from/{sourceType}/{sourceId}" path appended, the path is sourceType and sourceId are calculated from the supplied reference

from

Navigation.RelationToNav from(Class sourceClass,
                              String sourceId)

Returns:

a from navigation builder with the "from/{sourceType}/{sourceId}" path appended to the existing path, the returned navigation builder supports the an additional "to" path to be appended