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

Class ScriptBindingDocumentation

java.lang.Object

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

public class ScriptBindingDocumentation
extends Object

A class that hold the documentation of one function or one variable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptBindingDocumentation.Argument	Describes an argument when a function is documented
static class	ScriptBindingDocumentation.Example	Example
static class	ScriptBindingDocumentation.Signature	A signature.

Field Summary

Fields

Modifier and Type	Field	Description
private List<ScriptBindingDocumentation.Example>	_examples
private I18nizableText	_name
private ScriptBindingDocumentation.Signature	_signature
private I18nizableText	_text

Constructor Summary

Constructors

Constructor	Description
ScriptBindingDocumentation(I18nizableText name, I18nizableText text, ScriptBindingDocumentation.Signature signature, List<ScriptBindingDocumentation.Example> examples)	Creates a documentation object

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()	The documentation as a map
List<ScriptBindingDocumentation.Example>	getExamples()	The examples
I18nizableText	getName()	The documentation name
ScriptBindingDocumentation.Signature	getSignature()	The signature
I18nizableText	getText()	The description

Methods inherited from class java.lang.Object

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

Field Detail

_name

private I18nizableText _name

_text

private I18nizableText _text

_signature

private ScriptBindingDocumentation.Signature _signature

_examples

private List<ScriptBindingDocumentation.Example> _examples

Constructor Detail

ScriptBindingDocumentation

public ScriptBindingDocumentation(I18nizableText name,
                                  I18nizableText text,
                                  ScriptBindingDocumentation.Signature signature,
                                  List<ScriptBindingDocumentation.Example> examples)

Creates a documentation object

Parameters:

name - The name of the documented stuff

text - The description

signature - The signature

examples - The examples

Method Detail

asMap

public Map<String,Object> asMap()

The documentation as a map

Returns:

The documentation as a map

getName

public I18nizableText getName()

The documentation name

Returns:

The documentation name

getText

public I18nizableText getText()

The description

Returns:

The description

getSignature

public ScriptBindingDocumentation.Signature getSignature()

The signature

Returns:

The signature

getExamples

public List<ScriptBindingDocumentation.Example> getExamples()

The examples

Returns:

The examples