PathReferencesService.Hit.Property.Value (Composum Nodes API (Commons) Bundle 4.3.3 API)

All Known Implementing Classes:

PathReferencesServiceImpl.HitIteratorImpl.IteratorHit.HitProperty.HitValue

Enclosing interface:

PathReferencesService.Hit.Property
```
public static interface PathReferencesService.Hit.Property.Value
```
a value which contains references of the searched path

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`@NotNull String`	`apply(@NotNull String newPath)`	replaces the old path of the value with the given new one
`int`	`getIndex()`
`@NotNull List<String>`	`getPaths()`
`@NotNull String`	`getText()`
`boolean`	`isAbsolute()`
`boolean`	`isChildPath()`
`boolean`	`isRelative()`
`boolean`	`isRichText()`

- Method Detail
  - getIndex
```
int getIndex()
```
    Returns:
    
    the index of the value in a multi value set
  - apply
```
@NotNull
@NotNull String apply(@NotNull
                      @NotNull String newPath)
```
    replaces the old path of the value with the given new one
    
    Parameters:
    
    newPath - the new path
    
    Returns:
    
    the modified value
  - getText
```
@NotNull
@NotNull String getText()
```
    Returns:
    
    the whole property value text
  - getPaths
```
@NotNull
@NotNull List<String> getPaths()
```
    Returns:
    
    the set of occurences of the searched path in the text
  - isAbsolute
```
boolean isAbsolute()
```
    Returns:
    
    'true', if at least one ocurrence of the path is absolute
  - isRelative
```
boolean isRelative()
```
    Returns:
    
    'true', if at least one ocurrence of the path is relative
  - isChildPath
```
boolean isChildPath()
```
    Returns:
    
    'true', if at least one ocurrence of the path is referencing a child resource
  - isRichText
```
boolean isRichText()
```
    Returns:
    
    'true', if the text seems to be a rich text