Package com.atlassian.confluence.api.nav
Interface Navigation.Builder
-
- All Known Subinterfaces:
Navigation.ContentNav
,Navigation.ContentRestrictionByOperationNav
,Navigation.ExperimentalContentNav
,Navigation.ExperimentalContentTemplateNav
,Navigation.ExperimentalNav
,Navigation.ExperimentalSynchronyDataNav
,Navigation.GroupNav
,Navigation.LongTaskNav
,Navigation.SpaceContentNav
,Navigation.SpaceNav
,Navigation.UserNav
,RestNavigation.RestBuilder
- All Known Implementing Classes:
AbstractNav
,BaseNav
- Enclosing interface:
- Navigation
public static interface Navigation.Builder
-
-
Field Summary
Fields Modifier and Type Field Description static Navigation.Builder
NONE
Some Model classes need to provide a builder, but don't need to provide any navigation.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
buildAbsolute()
build an absolute URL http://localhost:8080/confluence/rest/of/urlString
buildCanonicalAbsolute()
build an absolute URL substituting the confuence configured base url and context for the base url and context supplied by the url builderString
buildRelative()
build a relative URL without webapp context, i.e.String
buildRelativeWithContext()
build a relative URL with webapp context, i.e.
-
-
-
Field Detail
-
NONE
static final Navigation.Builder NONE
Some Model classes need to provide a builder, but don't need to provide any navigation. This no-op builder should be safe to use everywhere that a Navigation.Builder is expected.
-
-
Method Detail
-
buildAbsolute
String buildAbsolute()
build an absolute URL http://localhost:8080/confluence/rest/of/url
-
buildCanonicalAbsolute
String buildCanonicalAbsolute()
build an absolute URL substituting the confuence configured base url and context for the base url and context supplied by the url builder- Returns:
- a canonical url for this navigation path
-
buildRelative
String buildRelative()
build a relative URL without webapp context, i.e. /rest/of/url
-
buildRelativeWithContext
String buildRelativeWithContext()
build a relative URL with webapp context, i.e. /confluence/rest/of/url
-
-