ij-16.png   inspectorJ -- JavaTM Profiler
sf project site browse source checkout source
SourceForge.net Logo



inspectorj::client::SessionProfile

inspectorj::client::SessionProfile Class Reference

#include <sessionprofile.h>

Collaboration diagram for inspectorj::client::SessionProfile:

Collaboration graph
[legend]
List of all members.

Detailed Description

SessionProfile class encapsulates user settings for a profiling session.

Definition at line 47 of file sessionprofile.h.

Public Member Functions

 SessionProfile ()
 Constructor.
 ~SessionProfile ()
 Destructor.
void setName (QString)
 Sets the name of the profile.
void setFileName (QString)
 Sets the profile's filename.
void setConnection (ijConnection)
 Sets the connectionName.
void setClassFilters (QStringList)
 Sets the class filters.
void addFilter (QString)
 Add a filter to the list of class filters.
void removeFilter (QString)
 Remove a filter from the list of class filters.
void setClassPath (QStringList)
 Set the classpath.
void setJavaOptions (QString)
 Set the java options.
void setApplicationArgs (QString)
 Set the java application arguments.
void setApplicationEntry (QString)
 Set the main java class or jar file.
void setJreHome (QString)
 Set the path to the jre that will be used by this profile.
void setJarFile (bool)
 Set the jarFile bool property.
void setTomcatApp (bool)
 Set the tomcatApp bool property.
void setExternalLaunch (bool)
 Set the externalLaunch bool property.
QString getName ()
 Returns the name of the profile.
ijConnection getConnection ()
 Returns the connection used by this profile.
QStringList getClassFilters ()
 Returns a list of class filters used by this profile.
QStringList getClassPath ()
 Return list of classpath entries.
QString getJavaOptions ()
 Return the java vm options.
QString getApplicationArgs ()
 Return the java application arguments.
QString getApplicationEntry ()
 Return the name of the main java class or jar file.
QString getFileName ()
 Returns the filename of the profile.
QString getJreHome ()
 Return the path to the jre that will be used by this profile
Returns:
path of the jre home.

bool isJarFile ()
 Return true if the java entry is a jar file.
bool isTomcatApp ()
 Return true if the application entry is tomcat.
bool isExternalLaunch ()
 Return true if the jvm for this profile session will be launched externally.

Private Attributes

QString name
 The name of the profile.
ijConnection connection
 The connection.
QString fileName
 The name of the file this profile will be saved to.
QStringList classFilters
 A list of class filters to profile/instrument.
QStringList classPath
 Class search path of directories and zip/jar files.
QString javaOptions
 Java vm options.
QString applicationArgs
 Args to be passed to the java application.
QString applicationEntry
 The name of the main java class or jar file.
bool jarFile
 Bool to indicate whether applicationEntry is a jar file.
bool tomcatApp
 Bool to indicate whether appliationEntry is tomcat.
bool externalLaunch
 Bool to indicate whether the jvm for this profile will be launched externally.
QString jreHome
 Path to the jre home to use with this profile.

Constructor & Destructor Documentation

inspectorj::client::SessionProfile::SessionProfile (  ) 

Constructor.

Definition at line 35 of file sessionprofile.cpp.

inspectorj::client::SessionProfile::~SessionProfile (  ) 

Destructor.

Definition at line 42 of file sessionprofile.cpp.

Member Function Documentation

void inspectorj::client::SessionProfile::setName ( QString  name  ) 

Sets the name of the profile.

Parameters:
name The name to set.

Definition at line 50 of file sessionprofile.cpp.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), inspectorj::client::SessionProfileDialog::saveProfile(), and inspectorj::client::SessionProfileDialog::SessionProfileDialog().

void inspectorj::client::SessionProfile::setFileName ( QString  name  ) 

Sets the profile's filename.

Parameters:
name The filename to set.

Definition at line 59 of file sessionprofile.cpp.

References fileName.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setConnection ( ijConnection  connection  ) 

Sets the connectionName.

Parameters:
connection Then name of the connection

Definition at line 68 of file sessionprofile.cpp.

References connection.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setClassFilters ( QStringList  classFilters  ) 

Sets the class filters.

Parameters:
classFilters List of classFilters (i.e. java.io.*, java.awt.**, etc.)

Definition at line 77 of file sessionprofile.cpp.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::addFilter ( QString   ) 

Add a filter to the list of class filters.

Definition at line 117 of file sessionprofile.cpp.

References classFilters.

Referenced by inspectorj::client::InspectorJ::addClassFilter().

void inspectorj::client::SessionProfile::removeFilter ( QString   ) 

Remove a filter from the list of class filters.

Definition at line 125 of file sessionprofile.cpp.

References classFilters.

Referenced by inspectorj::client::InspectorJ::removeClassFilter().

void inspectorj::client::SessionProfile::setClassPath ( QStringList  list  ) 

Set the classpath.

Parameters:
list A QStringList of classpath entries (directories, jar/zip files)

Definition at line 207 of file sessionprofile.cpp.

References classPath.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setJavaOptions ( QString  opts  ) 

Set the java options.

Parameters:
opts A QString of java vm options

Definition at line 216 of file sessionprofile.cpp.

References javaOptions.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setApplicationArgs ( QString  args  ) 

Set the java application arguments.

Parameters:
args A QString containing java application args

Definition at line 225 of file sessionprofile.cpp.

References applicationArgs.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setApplicationEntry ( QString  entry  ) 

Set the main java class or jar file.

Parameters:
entry The name of the main java class or jar file

Definition at line 234 of file sessionprofile.cpp.

References applicationEntry.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setJreHome ( QString  home  ) 

Set the path to the jre that will be used by this profile.

Parameters:
home path of the jre home

Definition at line 243 of file sessionprofile.cpp.

References jreHome.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setJarFile ( bool  jarFile  ) 

Set the jarFile bool property.

Parameters:
jarFile 

Definition at line 261 of file sessionprofile.cpp.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setTomcatApp ( bool  tomcatApp  ) 

Set the tomcatApp bool property.

Parameters:
tomcatApp 

Definition at line 252 of file sessionprofile.cpp.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

void inspectorj::client::SessionProfile::setExternalLaunch ( bool  externalLaunch  ) 

Set the externalLaunch bool property.

If true this indicates that the jvm for this profile session will be launched externally. False means that the inspectorJ client will launch the jvm.

Parameters:
externalLaunch 

Definition at line 272 of file sessionprofile.cpp.

Referenced by inspectorj::toolset::ProfileToolSet::loadProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

QString inspectorj::client::SessionProfile::getName (  ) 

Returns the name of the profile.

Definition at line 85 of file sessionprofile.cpp.

References name.

Referenced by inspectorj::client::InspectorJ::connected(), inspectorj::client::SessionProfileDialog::initDialog(), inspectorj::client::InspectorJ::javaAppStarted(), inspectorj::toolset::ProfileToolSet::saveProfile(), inspectorj::client::SessionProfileDialog::saveProfile(), and inspectorj::client::InspectorJ::updateSessionsMenu().

ijConnection inspectorj::client::SessionProfile::getConnection (  ) 

Returns the connection used by this profile.

Definition at line 101 of file sessionprofile.cpp.

References connection.

Referenced by cbVMInit(), inspectorj::client::SessionProfileDialog::initDialog(), inspectorj::client::InspectorJ::javaAppStarted(), inspectorj::toolset::ProfileToolSet::saveProfile(), startServer(), and inspectorj::client::InspectorJ::updateSessionsMenu().

QStringList inspectorj::client::SessionProfile::getClassFilters (  ) 

Returns a list of class filters used by this profile.

Definition at line 109 of file sessionprofile.cpp.

References classFilters.

Referenced by inspectorj::client::SessionProfileDialog::initDialog(), parseOptions(), inspectorj::toolset::ProfileToolSet::saveProfile(), and inspectorj::client::InspectorJ::updateClassToolBox().

QStringList inspectorj::client::SessionProfile::getClassPath (  ) 

Return list of classpath entries.

Returns:
QStringList of classpath entries

Definition at line 134 of file sessionprofile.cpp.

References classPath.

Referenced by inspectorj::client::ConnectionManager::buildCmdString(), inspectorj::client::SessionProfileDialog::initDialog(), and inspectorj::toolset::ProfileToolSet::saveProfile().

QString inspectorj::client::SessionProfile::getJavaOptions (  ) 

Return the java vm options.

Returns:
QString of java vm options

Definition at line 143 of file sessionprofile.cpp.

References javaOptions.

Referenced by inspectorj::client::ConnectionManager::buildCmdString(), inspectorj::client::SessionProfileDialog::initDialog(), and inspectorj::toolset::ProfileToolSet::saveProfile().

QString inspectorj::client::SessionProfile::getApplicationArgs (  ) 

Return the java application arguments.

Returns:
QString of java application args

Definition at line 152 of file sessionprofile.cpp.

References applicationArgs.

Referenced by inspectorj::client::ConnectionManager::buildCmdString(), inspectorj::client::SessionProfileDialog::initDialog(), and inspectorj::toolset::ProfileToolSet::saveProfile().

QString inspectorj::client::SessionProfile::getApplicationEntry (  ) 

Return the name of the main java class or jar file.

Returns:
the name of the main java class or jar file

Definition at line 161 of file sessionprofile.cpp.

References applicationEntry.

Referenced by inspectorj::client::ConnectionManager::buildCmdString(), inspectorj::client::SessionProfileDialog::initDialog(), and inspectorj::toolset::ProfileToolSet::saveProfile().

QString inspectorj::client::SessionProfile::getFileName (  ) 

Returns the filename of the profile.

Definition at line 93 of file sessionprofile.cpp.

References fileName.

Referenced by inspectorj::client::ConnectionManager::buildCmdString(), inspectorj::toolset::ProfileToolSet::saveProfile(), and inspectorj::client::SessionProfileDialog::saveProfile().

QString inspectorj::client::SessionProfile::getJreHome (  ) 

Return the path to the jre that will be used by this profile

Returns:
path of the jre home.

Definition at line 170 of file sessionprofile.cpp.

References jreHome.

Referenced by inspectorj::client::ConnectionManager::buildCmdString(), inspectorj::client::SessionProfileDialog::initDialog(), and inspectorj::toolset::ProfileToolSet::saveProfile().

bool inspectorj::client::SessionProfile::isJarFile (  ) 

Return true if the java entry is a jar file.

Returns:
true if the java entry is a jar file

Definition at line 189 of file sessionprofile.cpp.

References jarFile.

Referenced by inspectorj::client::ConnectionManager::buildCmdString(), inspectorj::client::SessionProfileDialog::initDialog(), and inspectorj::toolset::ProfileToolSet::saveProfile().

bool inspectorj::client::SessionProfile::isTomcatApp (  ) 

Return true if the application entry is tomcat.

Returns:
true if the application entry is tomcat.

Definition at line 198 of file sessionprofile.cpp.

References tomcatApp.

Referenced by inspectorj::client::ConnectionManager::buildCmdString(), inspectorj::client::SessionProfileDialog::initDialog(), and inspectorj::toolset::ProfileToolSet::saveProfile().

bool inspectorj::client::SessionProfile::isExternalLaunch (  ) 

Return true if the jvm for this profile session will be launched externally.

Returns:
true if the jvm will be launched externally

Definition at line 180 of file sessionprofile.cpp.

References externalLaunch.

Referenced by inspectorj::client::SessionProfileDialog::initDialog(), inspectorj::toolset::ProfileToolSet::saveProfile(), and inspectorj::client::InspectorJ::updateSessionsMenu().

Member Data Documentation

QString inspectorj::client::SessionProfile::name [private]

The name of the profile.

Definition at line 86 of file sessionprofile.h.

Referenced by getName().

ijConnection inspectorj::client::SessionProfile::connection [private]

The connection.

Definition at line 89 of file sessionprofile.h.

Referenced by getConnection(), and setConnection().

QString inspectorj::client::SessionProfile::fileName [private]

The name of the file this profile will be saved to.

Definition at line 92 of file sessionprofile.h.

Referenced by getFileName(), and setFileName().

QStringList inspectorj::client::SessionProfile::classFilters [private]

A list of class filters to profile/instrument.

Definition at line 95 of file sessionprofile.h.

Referenced by addFilter(), getClassFilters(), and removeFilter().

QStringList inspectorj::client::SessionProfile::classPath [private]

Class search path of directories and zip/jar files.

Definition at line 98 of file sessionprofile.h.

Referenced by getClassPath(), and setClassPath().

QString inspectorj::client::SessionProfile::javaOptions [private]

Java vm options.

Definition at line 101 of file sessionprofile.h.

Referenced by getJavaOptions(), and setJavaOptions().

QString inspectorj::client::SessionProfile::applicationArgs [private]

Args to be passed to the java application.

Definition at line 104 of file sessionprofile.h.

Referenced by getApplicationArgs(), and setApplicationArgs().

QString inspectorj::client::SessionProfile::applicationEntry [private]

The name of the main java class or jar file.

Definition at line 107 of file sessionprofile.h.

Referenced by getApplicationEntry(), and setApplicationEntry().

bool inspectorj::client::SessionProfile::jarFile [private]

Bool to indicate whether applicationEntry is a jar file.

Definition at line 110 of file sessionprofile.h.

Referenced by isJarFile().

bool inspectorj::client::SessionProfile::tomcatApp [private]

Bool to indicate whether appliationEntry is tomcat.

Definition at line 113 of file sessionprofile.h.

Referenced by isTomcatApp().

bool inspectorj::client::SessionProfile::externalLaunch [private]

Bool to indicate whether the jvm for this profile will be launched externally.

False means that the inspectorJ client will launch the jvm.

Definition at line 120 of file sessionprofile.h.

Referenced by isExternalLaunch().

QString inspectorj::client::SessionProfile::jreHome [private]

Path to the jre home to use with this profile.

Definition at line 123 of file sessionprofile.h.

Referenced by getJreHome(), and setJreHome().

The documentation for this class was generated from the following files:
Generated on Sun Aug 19 17:08:16 2007 for inspectorJ by  doxygen 1.5.1