Package com.pnfsoftware.jeb.core

Class ScriptMetadata

java.lang.Object

com.pnfsoftware.jeb.core.ScriptMetadata

public class ScriptMetadata
extends Object

Metadata information for a JEB script (type, description, version, etc.).

Constructor Summary

Constructors

Constructor	Description
ScriptMetadata()	Create an empty script-metadata object.

Method Summary

Modifier and Type	Method	Description
String	getAuthor()	Get the script author.
String	getDescription()	Get the script description.
String	getShortcut()	Get the declared script shortcut.
String	getType()	Get the declared script type.
Version	getVersion()	Get the declared script version.
boolean	isDeprecated()	Determine whether the script is marked as deprecated.
boolean	isNolist()	Determine whether the script should be omitted from listings.

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptMetadata

public ScriptMetadata()

Create an empty script-metadata object.

Method Details

getType

public String getType()

Get the declared script type.

Returns:

script type, or null if unspecified

getDescription

public String getDescription()

Get the script description.

Returns:

description, or null if unspecified

getAuthor

public String getAuthor()

Get the script author.

Returns:

author, or null if unspecified

getVersion

public Version getVersion()

Get the declared script version.

Returns:

version, or null if unspecified

getShortcut

public String getShortcut()

Get the declared script shortcut.

Returns:

shortcut string, or null if unspecified

isDeprecated

public boolean isDeprecated()

Determine whether the script is marked as deprecated.

Returns:

true if the script is deprecated

isNolist

public boolean isNolist()

Determine whether the script should be omitted from listings.

Returns:

true if the script is marked with nolist