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

Class ScriptBindingDocumentation.Signature

java.lang.Object

org.ametys.plugins.core.ui.script.ScriptBindingDocumentation.Signature

Enclosing class:

ScriptBindingDocumentation

public static class ScriptBindingDocumentation.Signature
extends Object

A signature.

Field Summary

Fields

Modifier and Type	Field	Description
private List<ScriptBindingDocumentation.Argument>	_arguments
private List<ScriptBindingDocumentation.Argument>	_returnSubtype
private I18nizableText	_returnText
private String	_returnType

Constructor Summary

Constructors

Constructor	Description
Signature(String returnType, List<ScriptBindingDocumentation.Argument> signatureSubtype, I18nizableText returnText, List<ScriptBindingDocumentation.Argument> arguments)	Builds a signature

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()	The signature as map
List<ScriptBindingDocumentation.Argument>	getArguments()	The arguments (when a function)
List<ScriptBindingDocumentation.Argument>	getSubtype()	The description of the type when it is an object.
I18nizableText	getText()	The description
String	getType()	The type (or return type for a function)

Methods inherited from class java.lang.Object

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

Field Detail

_returnType

private String _returnType

_returnSubtype

private List<ScriptBindingDocumentation.Argument> _returnSubtype

_returnText

private I18nizableText _returnText

_arguments

private List<ScriptBindingDocumentation.Argument> _arguments

Constructor Detail

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 function

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

returnText - The text

arguments - The arguments for a function

Method Detail

asMap

public Map<String,Object> asMap()

The signature as map

Returns:

The signature as map

getType

public String getType()

The type (or return type for a function)

Returns:

The type (or return type for a function)

getSubtype

public List<ScriptBindingDocumentation.Argument> getSubtype()

The description of the type when it is an object.

Returns:

Description or null.

getText

public I18nizableText getText()

The description

Returns:

The description

getArguments

public List<ScriptBindingDocumentation.Argument> getArguments()

The arguments (when a function)

Returns:

The arguments (when a function)