Class ScriptBindingDocumentation.Signature
java.lang.Object
org.ametys.plugins.core.ui.script.ScriptBindingDocumentation.Signature
- Enclosing class:
- ScriptBindingDocumentation
A signature.
-
Constructor Summary
ConstructorDescriptionSignature
(String returnType, List<ScriptBindingDocumentation.Argument> signatureSubtype, I18nizableText returnText, List<ScriptBindingDocumentation.Argument> arguments) Builds a signature -
Method Summary
-
Constructor Details
-
Signature
public Signature(String returnType, List<ScriptBindingDocumentation.Argument> signatureSubtype, I18nizableText returnText, List<ScriptBindingDocumentation.Argument> arguments) Builds a signature- Parameters:
returnType
- The type or return type for a functionsignatureSubtype
- Description of the type when it is an object. null otherwisereturnText
- The textarguments
- The arguments for a function
-
-
Method Details
-
asMap
The signature as map- Returns:
- The signature as map
-
getType
The type (or return type for a function)- Returns:
- The type (or return type for a function)
-
getSubtype
The description of the type when it is an object.- Returns:
- Description or null.
-
getText
The description- Returns:
- The description
-
getArguments
The arguments (when a function)- Returns:
- The arguments (when a function)
-