Package com.pnfsoftware.jeb.core

Class ScriptMetadataParser

java.lang.Object

com.pnfsoftware.jeb.core.ScriptMetadataParser

public class ScriptMetadataParser
extends Object

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
 

Constructor Summary

Constructors

Constructor	Description
ScriptMetadataParser()

Method Summary

Modifier and Type	Method	Description
static ScriptMetadata	extract(File file)
static ScriptMetadata	extract(File file, String commentPrefix)

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptMetadataParser

public ScriptMetadataParser()

Method Details

extract

public static ScriptMetadata extract(File file)
                              throws IOException

Throws:

IOException

extract

public static ScriptMetadata extract(File file,
 String commentPrefix)
                              throws IOException

Throws:

IOException