FCL/sftools/dev/build: buildframework/helium/external/helium-antlib/doc/src/structure.rst@d8ac696cc51f (annotated)

1 be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	1	==============================
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	2	Project Development guidelines
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	3	==============================
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	4
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	5
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	6	Helium Antlib is a standalone project which is completely independent from Helium. Its only main requirements are:
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	7	* Ant 1.7.0
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	8	* JDK 1.6 or newer
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	9
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	10	The project is split in several sub-modules which cover specific features.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	11
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	12	Anatomy of the project
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	13	======================
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	14
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	15	::
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	16
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	17	- build.xml
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	18	- bld.bat
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	19	- bld.sh
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	20	+ antlibs
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	21	Ant specific dependencies needed to execute ant properly
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	22	e.g: Java checkstyle, Code coverage tools
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	23	The jar in that folder will not be used as compilation dependencies
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	24	+ lib
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	25	Common dependencies between modules.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	26	e.g: common logging, ...
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	27	+ doc
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	28	General documentation of the project
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	29	+ module1
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	30	+ module1
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	31	+ modulen...
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	32
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	33
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	34	Anatomy of a module
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	35	===================
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	36
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	37	A module contains a set of Ant feature related to a specific domain (e.g: Diamonds, SCM). The following diagram shows
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	38	the physical structure of a module.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	39
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	40	::
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	41
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	42	+ <module_name>
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	43	- build.xml
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	44	- bld.bat
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	45	- bld.sh
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	46	+ lib
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	47	module specific jar dependencies
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	48	+ src
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	49	+ com
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	50	+ nokia
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	51	+ helium
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	52	+ <module_name>
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	53	+ ant
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	54	+ taskdefs
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	55	source of the Ant tasks
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	56	+ types
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	57	source of the Ant DataType
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	58	+ listener
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	59	source of the Ant Listener
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	60	+ condition
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	61	source of the Ant Conditions
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	62	+ tests
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	63	- build.xml
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	64	- bld.bat
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	65	- bld.sh
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	66	- test_xxx.ant.xml* - Unittest implemented using AntUnit
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	67	+ data
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	68	data used for the the unittests.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	69	+ src
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	70	+ com
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	71	+ nokia
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	72	+ helium
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	73	+ <module_name>
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	74	+ tests
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	75	source of junit unittests.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	76
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	77
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	78
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	79	General guidelines
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	80	==================
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	81
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	82	Distribution policy
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	83	-------------------
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	84
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	85	Each directory of the Antlib project must have a Distribution.policy.S60 file with the policy value 7 (see S60 guidelines).
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	86
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	87
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	88
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	89	External dependencies
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	90	---------------------
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	91
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	92	External dependencies added to the project must be in compliance with Nokia process and rules.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	93
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	94
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	95	Source code license
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	96	-------------------
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	97	Each file added to the project should include the following license header.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	98	::
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	99
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	100	/*
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	101	* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	102	* All rights reserved.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	103	* This component and the accompanying materials are made available
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	104	* under the terms of the License "Eclipse Public License v1.0"
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	105	* which accompanies this distribution, and is available
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	106	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	107	*
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	108	* Initial Contributors:
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	109	* Nokia Corporation - initial contribution.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	110	*
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	111	* Contributors:
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	112	*
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	113	* Description:
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	114	*
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	115	*/
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	116
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	117	Documentation
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	118	-------------
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	119
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	120	All classes and methods must be documented. Ant facade classes (like Task or DataType)
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	121	must be Antdoclet documented (preferably with usage example).
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	122
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	123	You can find more information on how to document Ant task using the Antdoclet plugin on http://antdoclet.neuroning.com/.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	124
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	125	Logging
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	126	-------
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	127
179 d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	128	Developer must preferably use standard Ant logging for any user log output.
1 be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	129	Internal debug logging must be implemented using Log4J framework.
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	130
179 d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	131	* ANT Listeners must use log4j logging framework - using Ant logging system might cause some looping issues.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	132	* Ant Type and Task must use the Ant logging mechanism to report to the user.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	133	* Generic framework (part of the code which doesn't links to Ant directly) must use Log4J.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	134	* Usage of System.out.println should be avoided.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	135	* All the non-handled exceptions should be considered as errors and should be reported as such:
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	136	* use log("message", Project.MSG_ERR) under Ant
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	137	* log.error() otherwise.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	138	* Exception to this rule must be clearly commented under the code.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	139	* Debug information:
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	140	* Log4J framework (log.debug()) must be used to push information to the Helium debug log - so debug information are not
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	141	directly visible by the user.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	142	* Ant logging framework can also be use to log Type/Task debug info (but log4j is preferred).
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	143	* PrintStackTrace method should be used on below scenario's:
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	144	* At the time of unknown exception.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	145	* Should be used with exceptions other than BuildException.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	146	* In case it is difficult to debug the issue with Exception.getMessage().
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	147	* use this method during debugging complex issue (this doesn't mean the line should remain in the code after development).
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	148	* When it is required to print the all the information about the occurring Exception.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	149
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	150
1 be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	151	This is an example on how to use logging:
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	152	::
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	153
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	154	import org.apache.log4j.Logger;
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	155
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	156	class MyClass extends Task {
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	157	private static Logger log = Logger.getLogger(MyClass.class);
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	158
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	159	public void execute() {
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	160	log("Executing...");
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	161	log.debug("some useful debug information.");
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	162	}
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	163	}
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	164
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	165
be27ed110b50 Bringing in Helium, imaker and cmaker Alex Gilkes <alex.gilkes@nokia.com> parents: diff changeset	166	Please find more information on Log4J from the online manual: http://logging.apache.org/log4j/1.2/manual.html.
179 d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	167
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	168
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	169	Exception
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	170	---------
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	171
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	172	Exceptional event reporting and handling is crutial in software development. Developer must make sure it is done accordingly
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	173	to the framework it is currently using:
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	174
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	175	* To report a build failure under Ant the BuildException must be used.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	176	But we have to keep in mind that a BuildException is not tracked because it derives from the RuntimeError type.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	177	So we have to be careful with those and try to limit their puprose to the original usage: Ant build failure.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	178	* It is preferable to have meaningful exception type like: FileNotFoundException.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	179	* Developer should try to avoid as much as possible the throw or catch raw type of exception like Exception, RuntimeError.
d8ac696cc51f helium_7.0-r14027 wbernard parents: 1 diff changeset	180

author	wbernard
	Wed, 23 Dec 2009 19:29:07 +0200
changeset 179	d8ac696cc51f
parent 1	be27ed110b50
permissions	-rw-r--r--