alma::acs::tools::comphelpergen::CompHelperClass Class Reference

Collaboration diagram for alma::acs::tools::comphelpergen::CompHelperClass:

[legend]

List of all members.

Public Member Functions
	CompHelperClass ()
	CompHelperClass (boolean verbose)
void	initCompHelper (String repositoryId, String componentClassName, String internalInterface, String idlPackage, String outputRootDir)
Protected Member Functions
String	computeFullOutputPath ()
String	computeFullXmlOutputPath ()
void	saveFile ()
Package Attributes
IOSpecification	ioSpecification
Private Member Functions
String	getImplPackage ()
String	getJavaComponentClass ()
String	getClassName ()
String	getClassJavadoc ()
String	getImports ()
String	ctor ()
String	createComponentImpl ()
String	getPOATieClass ()
String	getOperationsIrf ()
String	getInternalIrf ()
String	getLicenceHeader ()
String	getContents ()
Private Attributes
char	sep = File.separatorChar
String	m_outputRootDir
String	m_idlPackage
String	m_componentClassName
String	m_internalInterface
String	m_implPackage
String	m_operationsClass
String	m_repositoryId
boolean	m_verbose = false
Static Private Attributes
static final String	m_helperSuffix = "Helper"

---

Detailed Description

Author:

rgeorgie This class generates helper classes that are specified by the parameters componentClassName, internalInterface, idlPackage, outputRootDir.

---

Constructor & Destructor Documentation

alma::acs::tools::comphelpergen::CompHelperClass::CompHelperClass

(

)

[inline]

Constructs an object with a reference to the IO Specifications variables current directory.

See also:

java.lang.Object::Object()

References ioSpecification.

alma::acs::tools::comphelpergen::CompHelperClass::CompHelperClass

(

boolean

verbose

)

[inline]

Constructs an object with a reference to the IO Specifications variables current directory.

Parameters:

verbose

References ioSpecification, and m_verbose.

---

Member Function Documentation

String alma::acs::tools::comphelpergen::CompHelperClass::computeFullOutputPath

(

)

[inline, protected]

Gets the full output path without having the name of the output file.

Returns:

String

References m_implPackage, m_outputRootDir, m_verbose, and sep.

Referenced by saveFile().

String alma::acs::tools::comphelpergen::CompHelperClass::computeFullXmlOutputPath

(

)

[inline, protected]

Method computeFullXmlOutputPath.

Returns:

String

References m_implPackage, m_outputRootDir, m_verbose, and sep.

Referenced by alma::acs::tools::comphelpergen::CompHelperGenerator::saveHelperClasses().

String alma::acs::tools::comphelpergen::CompHelperClass::createComponentImpl

(

)

[inline, private]

Outputs the code for the method _createComponentImpl().

Returns:

String

References m_componentClassName, and m_helperSuffix.

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::ctor

(

)

[inline, private]

Outputs the code for the constructor method.

Returns:

String

References m_componentClassName, and m_helperSuffix.

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::getClassJavadoc

(

)

[inline, private]

Outputs the code with the author's name.

Returns:

String

References m_componentClassName, m_helperSuffix, m_implPackage, and m_repositoryId.

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::getClassName

(

)

[inline, private]

Outputs the the class name.

Returns:

String

References m_componentClassName, and m_helperSuffix.

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::getContents

(

)

[inline, private]

Collects all the blocks needed for outputing the current file's contents.

Returns:

String

References createComponentImpl(), ctor(), getClassJavadoc(), getClassName(), getImplPackage(), getImports(), getInternalIrf(), getLicenceHeader(), getOperationsIrf(), getPOATieClass(), and m_internalInterface.

Referenced by saveFile().

String alma::acs::tools::comphelpergen::CompHelperClass::getImplPackage

(

)

[inline, private]

Gets a line of code with the package description.

Returns:

String

References m_implPackage.

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::getImports

(

)

[inline, private]

Outputs the code for all the imports.

Returns:

String

References m_componentClassName, m_helperSuffix, m_idlPackage, m_internalInterface, and m_operationsClass.

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::getInternalIrf

(

)

[inline, private]

Outputs the code for the method _getInternalInterface().

Returns:

String

References m_helperSuffix, and m_internalInterface.

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::getJavaComponentClass

(

)

[inline, private]

Gets the full name of the file.

Returns:

String

References m_componentClassName, and m_helperSuffix.

Referenced by saveFile().

String alma::acs::tools::comphelpergen::CompHelperClass::getLicenceHeader

(

)

[inline, private]

Outputs the code for the LGPL.

Returns:

String

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::getOperationsIrf

(

)

[inline, private]

Outputs the code for the method _getOperationsInterface()

Returns:

String

References m_helperSuffix, and m_operationsClass.

Referenced by getContents().

String alma::acs::tools::comphelpergen::CompHelperClass::getPOATieClass

(

)

[inline, private]

Outputs the code for the method _getPOATieClass().

Returns:

String

References m_componentClassName, and m_helperSuffix.

Referenced by getContents().

void alma::acs::tools::comphelpergen::CompHelperClass::initCompHelper	(	String	repositoryId,
		String	componentClassName,
		String	internalInterface,
		String	idlPackage,
		String	outputRootDir
	)			[inline]

Returns an instance of the class.

Parameters:

	componentClassName
	internalInterface
	idlPackage
	outputRootDir

References ioSpecification, m_componentClassName, m_idlPackage, m_implPackage, m_internalInterface, m_operationsClass, m_outputRootDir, and m_repositoryId.

Referenced by alma::acs::tools::comphelpergen::CompHelperGeneratorTest::generateCompDir(), alma::acs::tools::comphelpergen::CompHelperGeneratorTest::generateHelpComp(), alma::acs::tools::comphelpergen::CompHelperGeneratorTest::generateHelpMixedComp(), alma::acs::tools::comphelpergen::CompHelperGeneratorTest::generateHelpXmlComp(), and alma::acs::tools::comphelpergen::CompHelperGenerator::saveHelperClasses().

void alma::acs::tools::comphelpergen::CompHelperClass::saveFile

(

)

[inline, protected]

Saves a file according to its contents and location.

References computeFullOutputPath(), getContents(), getJavaComponentClass(), ioSpecification, m_verbose, and alma::acs::tools::comphelpergen::IOSpecification::saveFile().

Referenced by alma::acs::tools::comphelpergen::CompHelperGenerator::saveHelperClasses().

---

Member Data Documentation

IOSpecification alma::acs::tools::comphelpergen::CompHelperClass::ioSpecification [package]

Referenced by CompHelperClass(), initCompHelper(), and saveFile().

String alma::acs::tools::comphelpergen::CompHelperClass::m_componentClassName [private]

Referenced by createComponentImpl(), ctor(), getClassJavadoc(), getClassName(), getImports(), getJavaComponentClass(), getPOATieClass(), and initCompHelper().

final String alma::acs::tools::comphelpergen::CompHelperClass::m_helperSuffix = "Helper" [static, private]

Referenced by createComponentImpl(), ctor(), getClassJavadoc(), getClassName(), getImports(), getInternalIrf(), getJavaComponentClass(), getOperationsIrf(), and getPOATieClass().

String alma::acs::tools::comphelpergen::CompHelperClass::m_idlPackage [private]

Referenced by getImports(), and initCompHelper().

String alma::acs::tools::comphelpergen::CompHelperClass::m_implPackage [private]

Referenced by computeFullOutputPath(), computeFullXmlOutputPath(), getClassJavadoc(), getImplPackage(), and initCompHelper().

String alma::acs::tools::comphelpergen::CompHelperClass::m_internalInterface [private]

Referenced by getContents(), getImports(), getInternalIrf(), and initCompHelper().

String alma::acs::tools::comphelpergen::CompHelperClass::m_operationsClass [private]

Referenced by getImports(), getOperationsIrf(), and initCompHelper().

String alma::acs::tools::comphelpergen::CompHelperClass::m_outputRootDir [private]

Referenced by computeFullOutputPath(), computeFullXmlOutputPath(), and initCompHelper().

String alma::acs::tools::comphelpergen::CompHelperClass::m_repositoryId [private]

Referenced by getClassJavadoc(), and initCompHelper().

boolean alma::acs::tools::comphelpergen::CompHelperClass::m_verbose = false [private]

Referenced by CompHelperClass(), computeFullOutputPath(), computeFullXmlOutputPath(), and saveFile().

char alma::acs::tools::comphelpergen::CompHelperClass::sep = File.separatorChar [private]

Referenced by computeFullOutputPath(), and computeFullXmlOutputPath().

---

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

• CompHelperClass.java