Package com.netflix.spinnaker.kork.api.expressions

Class ExpressionFunctionProvider.FunctionDocumentation

java.lang.Object

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

Enclosing interface:

ExpressionFunctionProvider

public static class ExpressionFunctionProvider.FunctionDocumentation
extends java.lang.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(java.lang.String documentation)
FunctionDocumentation(java.lang.String documentation, ExpressionFunctionProvider.FunctionUsageExample... examples)
FunctionDocumentation(java.lang.String documentation, java.util.List<ExpressionFunctionProvider.FunctionUsageExample> examples)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDocumentation()
java.util.List<ExpressionFunctionProvider.FunctionUsageExample>	getExamples()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionDocumentation

public FunctionDocumentation(java.lang.String documentation)

FunctionDocumentation

public FunctionDocumentation(java.lang.String documentation,
                             java.util.List<ExpressionFunctionProvider.FunctionUsageExample> examples)

FunctionDocumentation

public FunctionDocumentation(java.lang.String documentation,
                             ExpressionFunctionProvider.FunctionUsageExample... examples)

Method Detail

getDocumentation

public java.lang.String getDocumentation()

getExamples

@Nullable
public java.util.List<ExpressionFunctionProvider.FunctionUsageExample> getExamples()