Class ScriptBindingDocumentation.Argument
- java.lang.Object
-
- org.ametys.plugins.core.ui.script.ScriptBindingDocumentation.Argument
-
- Enclosing class:
- ScriptBindingDocumentation
public static class ScriptBindingDocumentation.Argument extends Object
Describes an argument when a function is documented
-
-
Field Summary
Fields Modifier and Type Field Description private String
_argumentName
private String
_argumentOptionalValue
private List<ScriptBindingDocumentation.Argument>
_argumentSubtype
private I18nizableText
_argumentText
private String
_argumentType
-
Constructor Summary
Constructors Constructor Description Argument(String argumentName, String argumentType, List<ScriptBindingDocumentation.Argument> argumentSubtype, I18nizableText argumentText, String optionalValue)
Builds an argument
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,Object>
asMap()
The argument as mapString
getName()
The name of the argumentString
getOptionalValue()
The type/class name of the argumentList<ScriptBindingDocumentation.Argument>
getSubtype()
Description of the type when it is an object.I18nizableText
getText()
The description of the argumentString
getType()
The type/class name of the argument
-
-
-
Field Detail
-
_argumentName
private String _argumentName
-
_argumentType
private String _argumentType
-
_argumentSubtype
private List<ScriptBindingDocumentation.Argument> _argumentSubtype
-
_argumentText
private I18nizableText _argumentText
-
_argumentOptionalValue
private String _argumentOptionalValue
-
-
Constructor Detail
-
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 Detail
-
getType
public String getType()
The type/class name of the argument- Returns:
- The type/class name of the argument
-
getSubtype
public List<ScriptBindingDocumentation.Argument> getSubtype()
Description of the type when it is an object.- Returns:
- Description or null otherwise
-
getText
public I18nizableText getText()
The description of the argument- Returns:
- The description of the argument
-
getOptionalValue
public String getOptionalValue()
The type/class name of the argument- Returns:
- The type/class name of the argument
-
-