ScriptBindingDocumentation.Example (Ametys 4.4.x - API)

java.lang.Object
- org.ametys.plugins.core.ui.script.ScriptBindingDocumentation.Example

Enclosing class:: ScriptBindingDocumentation

public static class ScriptBindingDocumentation.Example
extends Object

Example

Field Summary

Fields
Modifier and Type Field Description

private String _code

private I18nizableText _exampleText

Constructor Summary

Constructors
Constructor Description

Example(String code, I18nizableText text)
Creates an exemple

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Object>`	`asMap()`	The example as map
`String`	`getCode()`	The code
`I18nizableText`	`getText()`	Get the text

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_code
```
private String _code
```

_exampleText
```
private I18nizableText _exampleText
```

Constructor Detail

Example

public Example(String code,
               I18nizableText text)

Creates an exemple

Parameters:: code - Code; text - Associated text

Method Detail
- asMap
```
public Map<String,Object> asMap()
```
  The example as map
  
  Returns:
  
  The example as map
- getCode
```
public String getCode()
```
  The code
  
  Returns:
  
  The code
- getText
```
public I18nizableText getText()
```
  Get the text
  
  Returns:
  
  the text