Package org.ametys.plugins.core.ui.script

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

Modifier and Type	Method	Description
Map<String,Object>	asMap()	The argument as map
String	getName()	The name of the argument
String	getOptionalValue()	The type/class name of the argument
List<ScriptBindingDocumentation.Argument>	getSubtype()	Description of the type when it is an object.
I18nizableText	getText()	The description of the argument
String	getType()	The type/class name of the argument

Methods inherited from class java.lang.Object

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

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 name

argumentType - The type

argumentSubtype - Description of the type when it is an object. null otherwise

argumentText - The description

optionalValue - Null if the argument is mandatory, the default value otherwise such as "null" or "\"default\""

Method Detail

asMap

public Map<String,Object> asMap()

The argument as map

Returns:

The argument as map

getName

public String getName()

The name of the argument

Returns:

The name of the argument

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