RewriteContext (Hippo Site Toolkit API 15.4.0 API)

java.lang.Object
- org.hippoecm.hst.core.linking.RewriteContext

public class RewriteContext
extends Object

Constructor Summary

Constructors
Constructor Description

RewriteContext(String path, Mount mount, boolean canonical, boolean navigationStateful)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Mount`	`getMount()`
`String`	`getPath()`
`boolean`	`isCanonical()`
`boolean`	`isNavigationStateful()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RewriteContext
```
public RewriteContext(String path,
                      Mount mount,
                      boolean canonical,
                      boolean navigationStateful)
               throws RewriteContextException
```
    Parameters:
    
    path - the path to use for link creation, not allowed to be null
    
    mount - the Mount to use for link creation, not allowed to be null
    
    canonical - true when the link should be canonical
    
    navigationStateful - true when the link should be navigationStateful
    
    Throws:
    
    RewriteContextException - if path or mount is null
- Method Detail
  - getPath
```
public String getPath()
```
    Returns:
    
    the path to try the link creation for
  - getMount
```
public Mount getMount()
```
    Returns:
    
    the mount to try the link creation for
  - isCanonical
```
public boolean isCanonical()
```
    Returns:
    
    true when a canonical link should be created
  - isNavigationStateful
```
public boolean isNavigationStateful()
```
    Returns:
    
    true when the link must be navigationStateful
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object