public
class
ScriptMetadataParser
extends Object| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.core.ScriptMetadataParser |
Class Overview
Parser and generator of ScriptMetadata objects.
JEB script (client scripts, plugin scripts) may start with metadata in comments to provide
valuable information to the client or back-end without requiring full parsing and compilation of
the script. The metadata is provided at the top of the source file as inline comments, before any
code appears. The inline comment format is ?key=value where key is the metadata attribute
name.
Example, in a Python script:
#?description=A description string #?shortcut=CTRL+SHIFT+K
Example, in a Java script:
//?description=A description string //?shortcut=CTRL+SHIFT+K
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ScriptMetadataParser() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static ScriptMetadata | extract(File file) | ||||||||||
| static ScriptMetadata | extract(File file, String commentPrefix) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||