Project CASUAL
API for CASUAL
 All Classes Namespaces Functions Variables
Public Member Functions | List of all members
CASUAL.caspac.ScriptMeta Class Reference

Public Member Functions

 ScriptMeta (final Script script)
 
 ScriptMeta (Properties prop, final Script script)
 
 ScriptMeta (InputStream prop, final Script script) throws IOException
 
boolean verifyMeta ()
 
InputStream getMetaInputStream ()
 
boolean write (String output) throws FileNotFoundException, IOException
 
boolean write (File output) throws FileNotFoundException, IOException
 
ScriptMeta setPropsFromVariables ()
 
ScriptMeta load (Properties prop)
 
int minBuildNumber ()
 
String getMinBuildNumberVersion ()
 
ScriptMeta setMinBuildNumberVersion (String minBuildNumberVersion)
 
String getScriptRevision ()
 
ScriptMeta setScriptRevision (String scriptRevision)
 
String getUniqueIdentifier ()
 
ScriptMeta setUniqueIdentifier (String uniqueIdentifier)
 
String getSupportURL ()
 
ScriptMeta setSupportURL (String supportURL)
 
String getUpdateMessage ()
 
ScriptMeta setUpdateMessage (String updateMessage)
 
String getKillSwitchMessage ()
 
ScriptMeta setKillSwitchMessage (String killSwitchMessage)
 
Properties getMetaProp ()
 
ScriptMeta setMetaProp (Properties metaProp)
 
List< String > getMd5s ()
 
ScriptMeta setMd5s (List< String > md5s)
 
Script getScript ()
 
ScriptMeta setScript (Script script)
 
CASUALSettings.MonitorMode getMonitorMode ()
 
ScriptMeta setMonitorMode (CASUALSettings.MonitorMode monitorMode)
 
 ScriptMeta (final Script script)
 
 ScriptMeta (Properties prop, final Script script)
 
 ScriptMeta (InputStream prop, final Script script) throws IOException
 
boolean verifyMeta ()
 
InputStream getMetaInputStream ()
 
boolean write (String output) throws FileNotFoundException, IOException
 
boolean write (File output) throws FileNotFoundException, IOException
 
ScriptMeta setPropsFromVariables ()
 
ScriptMeta load (Properties prop)
 
int minBuildNumber ()
 
String getMinBuildNumberVersion ()
 
ScriptMeta setMinBuildNumberVersion (String minBuildNumberVersion)
 
String getScriptRevision ()
 
ScriptMeta setScriptRevision (String scriptRevision)
 
String getUniqueIdentifier ()
 
ScriptMeta setUniqueIdentifier (String uniqueIdentifier)
 
String getSupportURL ()
 
ScriptMeta setSupportURL (String supportURL)
 
String getUpdateMessage ()
 
ScriptMeta setUpdateMessage (String updateMessage)
 
String getKillSwitchMessage ()
 
ScriptMeta setKillSwitchMessage (String killSwitchMessage)
 
Properties getMetaProp ()
 
ScriptMeta setMetaProp (Properties metaProp)
 
List< String > getMd5s ()
 
ScriptMeta setMd5s (List< String > md5s)
 
Script getScript ()
 
ScriptMeta setScript (Script script)
 
CASUALSettings.MonitorMode getMonitorMode ()
 
ScriptMeta setMonitorMode (CASUALSettings.MonitorMode monitorMode)
 

Detailed Description

Meta provides a holding area and parsing for the metadata in the script.

Constructor & Destructor Documentation

CASUAL.caspac.ScriptMeta.ScriptMeta ( final Script  script)

constructor for new Meta.

Parameters
scriptscript this meta belongs to
CASUAL.caspac.ScriptMeta.ScriptMeta ( Properties  prop,
final Script  script 
)

Constructor for meta if properties file is available.

Parameters
propproperties file to load
scriptscript this meta belongs to
CASUAL.caspac.ScriptMeta.ScriptMeta ( InputStream  prop,
final Script  script 
) throws IOException

Constructor for meta if inputstrem properties is available.

Parameters
propproperties as inputstream.
scriptscript this meta belongs to
Exceptions
IOExceptionwhen permissions problem exists.
CASUAL.caspac.ScriptMeta.ScriptMeta ( final Script  script)

constructor for new Meta.

Parameters
scriptscript this meta belongs to
CASUAL.caspac.ScriptMeta.ScriptMeta ( Properties  prop,
final Script  script 
)

Constructor for meta if properties file is available.

Parameters
propproperties file to load
scriptscript this meta belongs to
CASUAL.caspac.ScriptMeta.ScriptMeta ( InputStream  prop,
final Script  script 
) throws IOException

Constructor for meta if inputstrem properties is available.

Parameters
propproperties as inputstream.
scriptscript this meta belongs to
Exceptions
IOExceptionwhen permissions problem exists.

Member Function Documentation

String CASUAL.caspac.ScriptMeta.getKillSwitchMessage ( )
Returns
the killSwitchMessage
String CASUAL.caspac.ScriptMeta.getKillSwitchMessage ( )
Returns
the killSwitchMessage
List<String> CASUAL.caspac.ScriptMeta.getMd5s ( )
Returns
the md5s
List<String> CASUAL.caspac.ScriptMeta.getMd5s ( )
Returns
the md5s
InputStream CASUAL.caspac.ScriptMeta.getMetaInputStream ( )

gets the metadata as an inputstream

Returns
metadata as inputstream.
InputStream CASUAL.caspac.ScriptMeta.getMetaInputStream ( )

gets the metadata as an inputstream

Returns
metadata as inputstream.
Properties CASUAL.caspac.ScriptMeta.getMetaProp ( )
Returns
the metaProp
Properties CASUAL.caspac.ScriptMeta.getMetaProp ( )
Returns
the metaProp
String CASUAL.caspac.ScriptMeta.getMinBuildNumberVersion ( )
Returns
the minBuildNumber
String CASUAL.caspac.ScriptMeta.getMinBuildNumberVersion ( )
Returns
the minBuildNumber
CASUALSettings.MonitorMode CASUAL.caspac.ScriptMeta.getMonitorMode ( )
Returns
the monitorMode
CASUALSettings.MonitorMode CASUAL.caspac.ScriptMeta.getMonitorMode ( )
Returns
the monitorMode
Script CASUAL.caspac.ScriptMeta.getScript ( )
Returns
the script
Script CASUAL.caspac.ScriptMeta.getScript ( )
Returns
the script
String CASUAL.caspac.ScriptMeta.getScriptRevision ( )
Returns
the scriptRevision
String CASUAL.caspac.ScriptMeta.getScriptRevision ( )
Returns
the scriptRevision
String CASUAL.caspac.ScriptMeta.getSupportURL ( )
Returns
the supportURL
String CASUAL.caspac.ScriptMeta.getSupportURL ( )
Returns
the supportURL
String CASUAL.caspac.ScriptMeta.getUniqueIdentifier ( )
Returns
the uniqueIdentifier
String CASUAL.caspac.ScriptMeta.getUniqueIdentifier ( )
Returns
the uniqueIdentifier
String CASUAL.caspac.ScriptMeta.getUpdateMessage ( )
Returns
the updateMessage
String CASUAL.caspac.ScriptMeta.getUpdateMessage ( )
Returns
the updateMessage
ScriptMeta CASUAL.caspac.ScriptMeta.load ( Properties  prop)
Parameters
propproperties file to load
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.load ( Properties  prop)
Parameters
propproperties file to load
Returns
this ScriptMeta
int CASUAL.caspac.ScriptMeta.minBuildNumber ( )

Minimum CASUAL minBuildNumber version requied by this script.

Returns
minBuildNumber version required.
int CASUAL.caspac.ScriptMeta.minBuildNumber ( )

Minimum CASUAL minBuildNumber version requied by this script.

Returns
minBuildNumber version required.
ScriptMeta CASUAL.caspac.ScriptMeta.setKillSwitchMessage ( String  killSwitchMessage)
Parameters
killSwitchMessagethe killSwitchMessage to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setKillSwitchMessage ( String  killSwitchMessage)
Parameters
killSwitchMessagethe killSwitchMessage to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setMd5s ( List< String >  md5s)
Parameters
md5sthe md5s to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setMd5s ( List< String >  md5s)
Parameters
md5sthe md5s to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setMetaProp ( Properties  metaProp)
Parameters
metaPropthe metaProp to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setMetaProp ( Properties  metaProp)
Parameters
metaPropthe metaProp to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setMinBuildNumberVersion ( String  minBuildNumberVersion)
Parameters
minBuildNumberVersionthe minBuildNumber to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setMinBuildNumberVersion ( String  minBuildNumberVersion)
Parameters
minBuildNumberVersionthe minBuildNumber to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setMonitorMode ( CASUALSettings.MonitorMode  monitorMode)
Parameters
monitorModethe monitorMode to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setMonitorMode ( CASUALSettings.MonitorMode  monitorMode)
Parameters
monitorModethe monitorMode to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setPropsFromVariables ( )

sets the properties object from local variables for writing

Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setPropsFromVariables ( )

sets the properties object from local variables for writing

Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setScript ( Script  script)
Parameters
scriptthe script to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setScript ( Script  script)
Parameters
scriptthe script to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setScriptRevision ( String  scriptRevision)
Parameters
scriptRevisionthe scriptRevision to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setScriptRevision ( String  scriptRevision)
Parameters
scriptRevisionthe scriptRevision to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setSupportURL ( String  supportURL)
Parameters
supportURLthe supportURL to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setSupportURL ( String  supportURL)
Parameters
supportURLthe supportURL to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setUniqueIdentifier ( String  uniqueIdentifier)
Parameters
uniqueIdentifierthe uniqueIdentifier to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setUniqueIdentifier ( String  uniqueIdentifier)
Parameters
uniqueIdentifierthe uniqueIdentifier to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setUpdateMessage ( String  updateMessage)
Parameters
updateMessagethe updateMessage to set
Returns
this ScriptMeta
ScriptMeta CASUAL.caspac.ScriptMeta.setUpdateMessage ( String  updateMessage)
Parameters
updateMessagethe updateMessage to set
Returns
this ScriptMeta
boolean CASUAL.caspac.ScriptMeta.verifyMeta ( )

verifies metadata is not empty

Returns
true if filled in
boolean CASUAL.caspac.ScriptMeta.verifyMeta ( )

verifies metadata is not empty

Returns
true if filled in
boolean CASUAL.caspac.ScriptMeta.write ( String  output) throws FileNotFoundException, IOException

writes meta properties to a file

Parameters
outputfile to write
Returns
true if file was written
Exceptions
FileNotFoundExceptionwhen file cannot be created
IOExceptionwhen permissions problem exists.
boolean CASUAL.caspac.ScriptMeta.write ( String  output) throws FileNotFoundException, IOException

writes meta properties to a file

Parameters
outputfile to write
Returns
true if file was written
Exceptions
FileNotFoundExceptionwhen file cannot be created
IOExceptionwhen permissions problem exists.
boolean CASUAL.caspac.ScriptMeta.write ( File  output) throws FileNotFoundException, IOException

writes meta properties to a file

Parameters
outputfile to write
Returns
true if file was written
Exceptions
FileNotFoundExceptionwhen file cannot be created
IOExceptionwhen permissions problem exists.
boolean CASUAL.caspac.ScriptMeta.write ( File  output) throws FileNotFoundException, IOException

writes meta properties to a file

Parameters
outputfile to write
Returns
true if file was written
Exceptions
FileNotFoundExceptionwhen file cannot be created
IOExceptionwhen permissions problem exists.

The documentation for this class was generated from the following file: