alma::acs::tools::comphelpergen::IOSpecification Class Reference

List of all members.

Protected Member Functions
String	getDir ()
void	saveFile (String contents, String file)
String	getExmplDir ()
String	getOutputRootDir ()
String	readingFile (String file)
Private Attributes
char	sep = System.getProperty("file.separator").charAt(0)

---

Detailed Description

Author:

rgeorgie

Class that is used for getting the current directory and saves a file when helper classes are generated.

---

Member Function Documentation

String alma::acs::tools::comphelpergen::IOSpecification::getDir

(

)

[inline, protected]

Gets the current root input directory.

Returns:

String

Referenced by getExmplDir(), getOutputRootDir(), and alma::acs::tools::comphelpergen::CompHelperGeneratorTest::testGenerateAllComp().

String alma::acs::tools::comphelpergen::IOSpecification::getExmplDir

(

)

[inline, protected]

Gets the directory where the sample files are found.

Returns:

String

References getDir(), and sep.

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

String alma::acs::tools::comphelpergen::IOSpecification::getOutputRootDir

(

)

[inline, protected]

Gets the directory where the sample files should be output.

Returns:

String

References getDir(), and sep.

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

String alma::acs::tools::comphelpergen::IOSpecification::readingFile

(

String

file

)

[inline, protected]

Reads a sample test file and ignores all the line terminators.

Returns:

String

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

void alma::acs::tools::comphelpergen::IOSpecification::saveFile	(	String	contents,
		String	file
	)			[inline, protected]

Saves a file given its contents and path are specified.

Parameters:

	contents
	file

Referenced by alma::acs::tools::comphelpergen::CompHelperClass::saveFile(), and alma::acs::tools::comphelpergen::CompHelperGenerator::saveHelperClasses().

---

Member Data Documentation

char alma::acs::tools::comphelpergen::IOSpecification::sep = System.getProperty("file.separator").charAt(0) [private]

Referenced by getExmplDir(), and getOutputRootDir().

---

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

• IOSpecification.java