Class ScriptBindingDocumentation.Argument
java.lang.Object
org.ametys.plugins.core.ui.script.ScriptBindingDocumentation.Argument
- Enclosing class:
- ScriptBindingDocumentation
Describes an argument when a function is documented
-
Constructor Summary
ConstructorDescriptionArgument
(String argumentName, String argumentType, List<ScriptBindingDocumentation.Argument> argumentSubtype, I18nizableText argumentText, String optionalValue) Builds an argument -
Method Summary
-
Constructor Details
-
Argument
public Argument(String argumentName, String argumentType, List<ScriptBindingDocumentation.Argument> argumentSubtype, I18nizableText argumentText, String optionalValue) Builds an argument- Parameters:
argumentName
- The nameargumentType
- The typeargumentSubtype
- Description of the type when it is an object. null otherwiseargumentText
- The descriptionoptionalValue
- Null if the argument is mandatory, the default value otherwise such as "null" or "\"default\""
-
-
Method Details
-
asMap
The argument as map- Returns:
- The argument as map
-
getName
The name of the argument- Returns:
- The name of the argument
-
getType
The type/class name of the argument- Returns:
- The type/class name of the argument
-
getSubtype
Description of the type when it is an object.- Returns:
- Description or null otherwise
-
getText
The description of the argument- Returns:
- The description of the argument
-
getOptionalValue
The type/class name of the argument- Returns:
- The type/class name of the argument
-