Skip to content

Commit 8371733

Browse files
committed
fix javadoc warning
Fixes #11046
1 parent 51320bb commit 8371733

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

logstash-core/src/main/java/org/logstash/plugins/ConfigVariableExpander.java

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,21 @@ public ConfigVariableExpander(SecretStore secretStore, EnvironmentVariableProvid
2222
}
2323

2424
/**
25-
* Replace all substitution variable references in @variable and returns the substituted value, or the
26-
* original value if a substitution cannot be made.
25+
* Replace all substitution variable references and returns the substituted value or the original value
26+
* if a substitution cannot be made.
2727
*
28-
* Process following patterns : ${VAR}, ${VAR:defaultValue}
28+
* Substitution variables have the patterns: <code>${VAR}</code> or <code>${VAR:defaultValue}</code>
2929
*
30-
* If value matches the pattern, the following precedence applies:
30+
* If a substitution variable is found, the following precedence applies:
3131
* Secret store value
3232
* Environment entry value
3333
* Default value if provided in the pattern
3434
* Exception raised
3535
*
36-
* If the value does not match the pattern, the 'value' param returns as-is
36+
* If a substitution variable is not found, the value is return unchanged
37+
*
38+
* @param value Config value in which substitution variables, if any, should be replaced.
39+
* @return Config value with any substitution variables replaced
3740
*/
3841
public Object expand(Object value) {
3942
String variable;

0 commit comments

Comments
 (0)