com.bristle.javalib.app
Class Application

java.lang.Object
  extended by com.bristle.javalib.app.Application

public class Application
extends Object

This class encapsulates data about an application (name, version, etc.)

Usage:
   - Typical scenarios for using this class are...
   - See the source code of the inner Tester class for more examples.
  
Assumptions:
Effects:
       - None.
Anticipated Changes:
Notes:
Implementation Notes:
Portability Issues:
Revision History:
   $Log$


Constructor Summary
Application()
           
 
Method Summary
 String getAcronym()
          Get the user-visible acronym of the application.
 String getCompanyAddress()
          Get the company address.
 String getCompanyEMailAddress()
          Get the company e-mail address.
 String getCompanyName()
          Get the company name.
 String getCompanyPhoneNumber()
          Get the company phone number.
 String getCompanyWebSiteURL()
          Get the company web site URL.
 String getDescrip()
          Get the description of the application, potentially multiple sentences.
 String getFullName()
          Get the full user-visible name of the application.
 String getInternalName()
          Get the internal name of the application, typically used in properties files and such, but not typically shown to the user.
 String getLargeImageFileName()
          Get the filename of the large image (GIF, JPG, etc.) for the application.
 String getLongCopyright()
          Get the long copyright of the application.
 int getMajorVersionNumber()
          Get the major version number of the application.
 int getMinorVersionNumber()
          Get the minor version number of the application.
 String getNotes()
          Get the notes about the application.
 int getRevisionNumber()
          Get the revision number of the application.
 String getShortCopyright()
          Get the short copyright of the application.
 String getShortName()
          Get the short user-visible name of the application.
 String getSmallImageFileName()
          Get the filename of the small image (GIF, JPG, etc.) for the application.
 String getVersionString()
          Get the user-visible version string of the application.
 void loadProperties(String strInternalName)
          Load all properties from a properties file, using the specified internal name as the identifier in the properties file.
 void setAcronym(String strVal)
          Set the user-visible acronym of the application.
 void setAll(String strFullName, String strShortName, String strAcronym, String strInternalName, String strVersionString, int intMajorVersionNumber, int intMinorVersionNumber, int intRevisionNumber, String strCompanyName, String strCompanyAddress, String strCompanyPhoneNumber, String strCompanyEMailAddress, String strCompanyWebSiteURL, String strShortCopyright, String strLongCopyright, String strSmallImageFileName, String strLargeImageFileName, String strDescrip, String strNotes)
          Set all properties.
 void setCompanyAddress(String strVal)
          Set the company address.
 void setCompanyEMailAddress(String strVal)
          Set the company e-mail address.
 void setCompanyName(String strVal)
          Set the company name.
 void setCompanyPhoneNumber(String strVal)
          Set the company phone number.
 void setCompanyWebSiteURL(String strVal)
          Set the company web site URL.
 void setDescrip(String strVal)
          Set the description of the application, potentially multiple sentences.
 void setFullName(String strVal)
          Set the full user-visible name of the application.
 void setInternalName(String strVal)
          Set the internal name of the application, typically used in property files and such, but not typically shown to the user.
 void setLargeImageFileName(String strVal)
          Get the filename of the large image (GIF, JPG, etc.) for the application.
 void setLongCopyright(String strVal)
          Set the long copyright of the application.
 void setMajorVersionNumber(int intVal)
          Set the major version number of the application.
 void setMinorVersionNumber(int intVal)
          Set the minor version number of the application.
 void setNotes(String strVal)
          Set the notes about the application.
 void setRevisionNumber(int intVal)
          Set the revision number of the application.
 void setShortCopyright(String strVal)
          Set the short copyright of the application.
 void setShortName(String strVal)
          Set the short user-visible name of the application.
 void setSmallImageFileName(String strVal)
          Get the filename of the small image (GIF, JPG, etc.) for the application.
 void setVersionString(String strVal)
          Set the user-visible version string of the application.
 void shallowCopyFrom(Application objFrom)
          Do a shallow copy of all properties from the specified object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Application

public Application()
Method Detail

setAll

public void setAll(String strFullName,
                   String strShortName,
                   String strAcronym,
                   String strInternalName,
                   String strVersionString,
                   int intMajorVersionNumber,
                   int intMinorVersionNumber,
                   int intRevisionNumber,
                   String strCompanyName,
                   String strCompanyAddress,
                   String strCompanyPhoneNumber,
                   String strCompanyEMailAddress,
                   String strCompanyWebSiteURL,
                   String strShortCopyright,
                   String strLongCopyright,
                   String strSmallImageFileName,
                   String strLargeImageFileName,
                   String strDescrip,
                   String strNotes)
Set all properties. Use this whenever you want to be sure that properties added in the future are also set. Once this method is updated to include a new property, all calls will fail to compile unless they are also updated.

Parameters:
strFullName - The property value.
strShortName - The property value.
strAcronym - The property value.
strInternalName - The property value.
strVersionString - The property value.
intMajorVersionNumber - The property value.
intMinorVersionNumber - The property value.
intRevisionNumber - The property value.
strCompanyName - The property value.
strCompanyAddress - The property value.
strCompanyPhoneNumber - The property value.
strCompanyEMailAddress - The property value.
strCompanyWebSiteURL - The property value.
strShortCopyright - The property value.
strLongCopyright - The property value.
strSmallImageFileName - The property value.
strLargeImageFileName - The property value.
strDescrip - The property value.
strNotes - The property value.

shallowCopyFrom

public void shallowCopyFrom(Application objFrom)
Do a shallow copy of all properties from the specified object.

Parameters:
objFrom - The object to copy from.

getFullName

public String getFullName()
Get the full user-visible name of the application.

Returns:
The name.

setFullName

public void setFullName(String strVal)
Set the full user-visible name of the application.

Parameters:
strVal - The value to set.

getShortName

public String getShortName()
Get the short user-visible name of the application.

Returns:
The name.

setShortName

public void setShortName(String strVal)
Set the short user-visible name of the application.

Parameters:
strVal - The value to set.

getAcronym

public String getAcronym()
Get the user-visible acronym of the application.

Returns:
The acronym.

setAcronym

public void setAcronym(String strVal)
Set the user-visible acronym of the application.

Parameters:
strVal - The value to set.

getInternalName

public String getInternalName()
Get the internal name of the application, typically used in properties files and such, but not typically shown to the user.

Returns:
The name.

setInternalName

public void setInternalName(String strVal)
Set the internal name of the application, typically used in property files and such, but not typically shown to the user.

Parameters:
strVal - The value to set.

getVersionString

public String getVersionString()
Get the user-visible version string of the application.

Returns:
The version string.

setVersionString

public void setVersionString(String strVal)
Set the user-visible version string of the application.

Parameters:
strVal - The value to set.

getMajorVersionNumber

public int getMajorVersionNumber()
Get the major version number of the application.

Returns:
The version number.

setMajorVersionNumber

public void setMajorVersionNumber(int intVal)
Set the major version number of the application.

Parameters:
intVal - The value to set.

getMinorVersionNumber

public int getMinorVersionNumber()
Get the minor version number of the application.

Returns:
The version number.

setMinorVersionNumber

public void setMinorVersionNumber(int intVal)
Set the minor version number of the application.

Parameters:
intVal - The value to set.

getRevisionNumber

public int getRevisionNumber()
Get the revision number of the application.

Returns:
The revision number.

setRevisionNumber

public void setRevisionNumber(int intVal)
Set the revision number of the application.

Parameters:
intVal - The value to set.

getCompanyName

public String getCompanyName()
Get the company name.

Returns:
The company name.

setCompanyName

public void setCompanyName(String strVal)
Set the company name.

Parameters:
strVal - The value to set.

getCompanyAddress

public String getCompanyAddress()
Get the company address.

Returns:
The company address.

setCompanyAddress

public void setCompanyAddress(String strVal)
Set the company address.

Parameters:
strVal - The value to set.

getCompanyPhoneNumber

public String getCompanyPhoneNumber()
Get the company phone number.

Returns:
The company phone number.

setCompanyPhoneNumber

public void setCompanyPhoneNumber(String strVal)
Set the company phone number.

Parameters:
strVal - The value to set.

getCompanyEMailAddress

public String getCompanyEMailAddress()
Get the company e-mail address.

Returns:
The company e-mail address.

setCompanyEMailAddress

public void setCompanyEMailAddress(String strVal)
Set the company e-mail address.

Parameters:
strVal - The value to set.

getCompanyWebSiteURL

public String getCompanyWebSiteURL()
Get the company web site URL.

Returns:
The company web site URL.

setCompanyWebSiteURL

public void setCompanyWebSiteURL(String strVal)
Set the company web site URL.

Parameters:
strVal - The value to set.

getShortCopyright

public String getShortCopyright()
Get the short copyright of the application.

Returns:
The copyright.

setShortCopyright

public void setShortCopyright(String strVal)
Set the short copyright of the application.

Parameters:
strVal - The value to set.

getLongCopyright

public String getLongCopyright()
Get the long copyright of the application.

Returns:
The copyright.

setLongCopyright

public void setLongCopyright(String strVal)
Set the long copyright of the application.

Parameters:
strVal - The value to set.

getSmallImageFileName

public String getSmallImageFileName()
Get the filename of the small image (GIF, JPG, etc.) for the application.

Returns:
The filename.

setSmallImageFileName

public void setSmallImageFileName(String strVal)
Get the filename of the small image (GIF, JPG, etc.) for the application.

Parameters:
strVal - The value to set.

getLargeImageFileName

public String getLargeImageFileName()
Get the filename of the large image (GIF, JPG, etc.) for the application.

Returns:
The filename.

setLargeImageFileName

public void setLargeImageFileName(String strVal)
Get the filename of the large image (GIF, JPG, etc.) for the application.

Parameters:
strVal - The value to set.

getDescrip

public String getDescrip()
Get the description of the application, potentially multiple sentences.

Returns:
The description.

setDescrip

public void setDescrip(String strVal)
Set the description of the application, potentially multiple sentences.

Parameters:
strVal - The value to set.

getNotes

public String getNotes()
Get the notes about the application.

Returns:
The notes.

setNotes

public void setNotes(String strVal)
Set the notes about the application.

Parameters:
strVal - The value to set.

loadProperties

public void loadProperties(String strInternalName)
Load all properties from a properties file, using the specified internal name as the identifier in the properties file.

Parameters:
strInternalName - The name to use when looking in properties files.