ExpressionFunctionProvider.FunctionDocumentation (kork-api 7.245.1 API)

java.lang.Object

com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.FunctionDocumentation

Enclosing interface:: ExpressionFunctionProvider

public static class ExpressionFunctionProvider.FunctionDocumentation extends Object

Documentation for a function.

This documentation is used by Deck to display in-line docs for a SpEL function.

Constructor Summary

Constructors

Constructor

Description

FunctionDocumentation(String documentation)

FunctionDocumentation(String documentation, ExpressionFunctionProvider.FunctionUsageExample... examples)

FunctionDocumentation(String documentation, List<ExpressionFunctionProvider.FunctionUsageExample> examples)
Method Summary

Modifier and Type

Method

Description

String

getDocumentation()

List<ExpressionFunctionProvider.FunctionUsageExample>

getExamples()

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

Constructor Details
- FunctionDocumentation
  
  public FunctionDocumentation(String documentation)
- FunctionDocumentation
  
  public FunctionDocumentation(String documentation, List<ExpressionFunctionProvider.FunctionUsageExample> examples)
- FunctionDocumentation
  
  public FunctionDocumentation(String documentation, ExpressionFunctionProvider.FunctionUsageExample... examples)
Method Details
- getDocumentation
  
  public String getDocumentation()
- getExamples
  
  @Nullable public List<ExpressionFunctionProvider.FunctionUsageExample> getExamples()