SubstituteString (container-search 7.523.17 API)

java.lang.Object
- com.yahoo.search.query.profile.SubstituteString

```
public class SubstituteString
extends Object
```
A string which contains one or more elements of the form %{name}, where these occurrences are to be replaced by a query profile lookup on name.
This objects does the analysis on creation and provides a (reasonably) fast method of performing the actual substitution (at lookup time).
This is a value object. Lookups in this are thread safe.

Author:

bratseth

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SubstituteString.Component`
`static class`	`SubstituteString.PropertyComponent`
`static class`	`SubstituteString.RelativePropertyComponent`	A component where the value should be looked up in the profile containing the substitution field rather than globally
`static class`	`SubstituteString.StringComponent`

Constructor Summary

Constructors
Constructor Description

SubstituteString(List<SubstituteString.Component> components, String stringValue)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<SubstituteString.Component>`	`components()`
`static SubstituteString`	`create(String value)`	Returns a new SubstituteString if the given string contains substitutions, null otherwise.
`boolean`	`equals(Object other)`
`int`	`hashCode()`
`boolean`	`hasRelative()`	Returns whether this has at least one relative component
`String`	`stringValue()`
`String`	`substitute(Map<String,String> context, com.yahoo.processing.request.Properties substitution)`	Perform the substitution in this, by looking up in the given properties, and returns the resulting string
`String`	`toString()`	Returns this string in original (unsubstituted) form

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

- Constructor Detail
  - SubstituteString
```
public SubstituteString(List<SubstituteString.Component> components,
                        String stringValue)
```
- Method Detail
  - create
```
public static SubstituteString create(String value)
```
    Returns a new SubstituteString if the given string contains substitutions, null otherwise.
  - hasRelative
```
public boolean hasRelative()
```
    Returns whether this has at least one relative component
  - substitute
```
public String substitute(Map<String,String> context,
                         com.yahoo.processing.request.Properties substitution)
```
    Perform the substitution in this, by looking up in the given properties, and returns the resulting string
    
    Parameters:
    
    context - the content which is used to resolve profile variants when looking up substitution values
    
    substitution - the properties in which values to be substituted are looked up
  - components
```
public List<SubstituteString.Component> components()
```
  - stringValue
```
public String stringValue()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Returns this string in original (unsubstituted) form
    
    Overrides:
    
    toString in class Object