PathReferencesService.Hit (Composum Nodes API (Commons) Bundle 4.3.5 API)

All Known Implementing Classes:

PathReferencesServiceImpl.HitIteratorImpl.IteratorHit

Enclosing interface:

PathReferencesService
```
public static interface PathReferencesService.Hit
```
a found resource which is referencing the searched path

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface PathReferencesService.Hit.Property
a property wich is referencing the searched path

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`@NotNull Iterable<PathReferencesService.Hit.Property>`	`getProperties()`
`@Nullable PathReferencesService.Hit.Property`	`getProperty()`
`@Nullable PathReferencesService.Hit.Property`	`getProperty(@NotNull String propertyName)`
`@NotNull Set<String>`	`getPropertyNames()`
`@NotNull org.apache.sling.api.resource.Resource`	`getResource()`
`PathReferencesService.Hit.Property.Value`	`getValue()`
`boolean`	`isRichText()`

- Method Detail
  - getResource
```
@NotNull
@NotNull org.apache.sling.api.resource.Resource getResource()
```
    Returns:
    
    the resource which is referencing the path
  - getPropertyNames
```
@NotNull
@NotNull Set<String> getPropertyNames()
```
    Returns:
    
    the set of the names of the matching properties
  - getProperties
```
@NotNull
@NotNull Iterable<PathReferencesService.Hit.Property> getProperties()
```
    Returns:
    
    the set of the names of the matching properties
  - getProperty
```
@Nullable
@Nullable PathReferencesService.Hit.Property getProperty(@NotNull
                                                         @NotNull String propertyName)
```
    Parameters:
    
    propertyName - the name of the matching property
    
    Returns:
    
    the value of the specified property
  - getProperty
```
@Nullable
@Nullable PathReferencesService.Hit.Property getProperty()
```
    Returns:
    
    the first matching property (one of the matching properties)
  - getValue
```
@Nullable
PathReferencesService.Hit.Property.Value getValue()
```
    Returns:
    
    the value of the first matching property (one of the matching values)
  - isRichText
```
boolean isRichText()
```
    Returns:
    
    'true', if the first matching value seems to be a rich text value