Mail Archive Home | gotm-commits List | December 2004 Index
| <-- Date Index --> | <-- Thread Index --> |
Date: Monday, December 20, 2004 @ 16:27:23
Author: rouvoy
Path: /cvsroot/gotm/fractal-xdoclet
Added: doc/overview.html
src/java/org/objectweb/fractal/xdoclet/package.html
Modified: .cvsignore build.xml
src/java/org/objectweb/fractal/xdoclet/FcAdlSubTask.java
src/java/org/objectweb/fractal/xdoclet/FractalTagsHandler.java
* Adding Javadoc documentation.
----------------------------------------------------------------+
.cvsignore | 1
build.xml | 3
doc/overview.html | 26 +++++
src/java/org/objectweb/fractal/xdoclet/FcAdlSubTask.java | 29 +++++
src/java/org/objectweb/fractal/xdoclet/FractalTagsHandler.java | 49
++++++++--
src/java/org/objectweb/fractal/xdoclet/package.html | 28 +++++
6 files changed, 127 insertions(+), 9 deletions(-)
Index: fractal-xdoclet/.cvsignore
diff -u fractal-xdoclet/.cvsignore:1.1 fractal-xdoclet/.cvsignore:1.2
--- fractal-xdoclet/.cvsignore:1.1 Thu Dec 16 17:57:18 2004
+++ fractal-xdoclet/.cvsignore Mon Dec 20 16:27:23 2004
@@ -1 +1,2 @@
build
+dist
Index: fractal-xdoclet/build.xml
diff -u fractal-xdoclet/build.xml:1.2 fractal-xdoclet/build.xml:1.3
--- fractal-xdoclet/build.xml:1.2 Fri Dec 17 17:49:13 2004
+++ fractal-xdoclet/build.xml Mon Dec 20 16:27:23 2004
@@ -15,7 +15,7 @@
<!-- USA -->
<!-- Initial developer(s): Romain Rouvoy. -->
<!-- Contributor(s): ______________________________________. -->
-<!-- $Id: build.xml,v 1.2 2004/12/17 16:49:13 rouvoy Exp $ -->
+<!-- $Id: build.xml,v 1.3 2004/12/20 15:27:23 rouvoy Exp $ -->
<!-- ==================================================================== -->
<project name="fractal-xdoclet" default="xdoclet-all">
<description>GoTM Project [gotm.objectweb.org] - Fractal
Xdoclet</description>
@@ -121,6 +121,7 @@
<package name="org.objectweb.fractal.lib.*" />
</group>
<link href="http://java.sun.com/j2se/1.4.2/docs/api/"; />
+ <link href="http://xdoclet.sourceforge.net/xdoclet/api/"; />
</javadoc>
<replace file="${build.dir}/${doc.dir}/overview-summary.html"
token="DO NOT REMOVE THIS LINE (will be automatically removed)." />
Index: fractal-xdoclet/doc/overview.html
diff -u /dev/null fractal-xdoclet/doc/overview.html:1.1
--- /dev/null Mon Dec 20 16:27:23 2004
+++ fractal-xdoclet/doc/overview.html Mon Dec 20 16:27:23 2004
@@ -0,0 +1,26 @@
+<!-- ==================================================================== -->
+<!-- GoTM: GoTM is an open Transaction Monitor -->
+<!-- Contact: gotm-team@xxxxxxxxxxxxx -->
+<!-- This library is free software; you can redistribute it and/or -->
+<!-- modify it under the terms of the GNU Lesser General Public -->
+<!-- License as published by the Free Software Foundation; either -->
+<!-- version 2.1 of the License, or any later version. -->
+<!-- This library is distributed in the hope that it will be useful, -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -->
+<!-- Lesser General Public License for more details. -->
+<!-- You should have received a copy of the GNU Lesser General Public -->
+<!-- License along with this library; if not, write to the Free Software -->
+<!-- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -->
+<!-- USA -->
+<!-- Initial developer(s): Romain Rouvoy. -->
+<!-- Contributor(s): ______________________________________. -->
+<!-- $Id: overview.html,v 1.1 2004/12/20 15:27:23 rouvoy Exp $ -->
+<!-- ==================================================================== -->
+<html>
+ <head>
+ <title>Fractal Template Package.</title>
+ </head>
+ <body> This project provides a set of XDoclet Tags to simplify the
development
+ of Fractal Applications. </body>
+</html>
\ No newline at end of file
Index:
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FcAdlSubTask.java
diff -u
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FcAdlSubTask.java:1.2
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FcAdlSubTask.java:1.3
---
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FcAdlSubTask.java:1.2
Fri Dec 17 17:49:13 2004
+++ fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FcAdlSubTask.java
Mon Dec 20 16:27:23 2004
@@ -23,56 +23,75 @@
Contributor(s): .
---------------------------------------------------------------------
-$Id: FcAdlSubTask.java,v 1.2 2004/12/17 16:49:13 rouvoy Exp $
+$Id: FcAdlSubTask.java,v 1.3 2004/12/20 15:27:23 rouvoy Exp $
====================================================================*/
package org.objectweb.fractal.xdoclet;
import xdoclet.TemplateSubTask;
/**
+ * Implementation of an Ant SubTask dedicated to Fractal ADl description file
+ * generation.
* @author <a href="mailto:Romain.Rouvoy@xxxxxxx";>Romain Rouvoy</a>
- * @version $Revision: 1.2 $
+ * @version $Revision: 1.3 $
* @created 15 déc. 2004
* @ant.element name="fractal-adl" parent="xdoclet.DocletTask"
display-name="Standard Subtask for Fractal ADL generation"
*/
public class FcAdlSubTask
extends TemplateSubTask
{
+ /** <code>FC_ADL_DTD</code> is the default Fractal ADL DTD applied to
the template. */
private final static String FC_ADL_DTD = "standard.dtd";
+ /** <code>FC_ADL_DEFAULT_TEMPLATE</code> is the default template file
used for generation. */
private final static String FC_ADL_DEFAULT_TEMPLATE =
"resources/FractalADLDescriptor.xdt";
+ /** <code>FC_PREFIX</code> is the default prefix used for the generated
file name. */
private final static String FC_PREFIX = "Fc";
+ /** <code>dtd</code> is the current DTD applied by the template. */
private String dtd = FC_ADL_DTD;
+ /** <code>prefix</code> is the current prefix used for the generated
file name. */
private String prefix = FC_PREFIX ;
+ /** <code>suffix</code> is the current suffix used for the generated
file name. */
private String suffix = "" ;
+ /** <code>templateController</code> is the name of the Fractal template
controller to use. */
private String templateController ;
+ /** <code>controller</code> is the name of the Fractal controller to
use. */
private String controller ;
/**
+ * Provides the value of the file name prefix.
* @return Returns the prefix.
*/
public final String getPrefix() {
return this.prefix;
}
+
/**
+ * Defines the value of the file name prefix.
* @param prefix The prefix to set.
*/
public final void setPrefix(final String prefix) {
this.prefix = prefix;
}
+
/**
+ * Provides the value of the file name suffix.
* @return Returns the suffix.
*/
public final String getSuffix() {
return this.suffix;
}
+
/**
+ * Defines the value of the file name suffix.
* @param suffix The suffix to set.
*/
public final void setSuffix(final String suffix) {
this.suffix = suffix;
}
+
/**
+ * Provides the value of the Fractal controller to use.
* @return Returns the controller.
*/
public final String getController() {
@@ -80,6 +99,7 @@
}
/**
+ * Defines the value of the Fractal controller to use.
* @param controller The controller to set.
*/
public final void setController(final String controller) {
@@ -87,6 +107,7 @@
}
/**
+ * Provides the value of the Fractal template controller to use.
* @return Returns the templateController.
*/
public final String getTemplateController() {
@@ -94,12 +115,15 @@
}
/**
+ * Defines the value of the Fractal template controller to use.
* @param templateController The templateController to set.
*/
public final void setTemplateController(final String templateController)
{
this.templateController = templateController;
}
+
/**
+ * Provides the value of the Fractal ADL DTD tu use.
* @return Returns the dtd.
*/
public final String getDtd() {
@@ -107,6 +131,7 @@
}
/**
+ * Defines the value of the Fractal ADL DTD to use.
* @param dtd The dtd to set.
*/
public final void setDtd(final String dtd) {
Index:
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FractalTagsHandler.java
diff -u
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FractalTagsHandler.java:1.1
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FractalTagsHandler.java:1.2
---
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FractalTagsHandler.java:1.1
Thu Dec 16 17:57:19 2004
+++
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/FractalTagsHandler.java
Mon Dec 20 16:27:23 2004
@@ -23,7 +23,7 @@
Contributor(s): .
---------------------------------------------------------------------
- $Id: FractalTagsHandler.java,v 1.1 2004/12/16 16:57:19 rouvoy Exp $
+ $Id: FractalTagsHandler.java,v 1.2 2004/12/20 15:27:23 rouvoy Exp $
====================================================================*/
package org.objectweb.fractal.xdoclet;
@@ -43,13 +43,14 @@
/**
* Tags relating to Fractal components being processed and class-level
attributes.
* @author <a href="mailto:Romain.Rouvoy@xxxxxxx";>Romain Rouvoy</a>
- * @version $Revision: 1.1 $
+ * @version $Revision: 1.2 $
* @xdoclet.taghandler namespace="Fractal"
*/
public class FractalTagsHandler
extends ClassTagsHandler
{
/**
+ * Checks if the interface description itf is a Fractal attribute
controller.
* @param itf the interface to check.
* @return true if the requested interface is an AttributeController
interface.
*/
@@ -58,6 +59,8 @@
}
/**
+ * Checks if the interface description itf is a Fractal controller
+ * (either Attribute, Binding or LifeCycle).
* @param itf the interface to check.
* @return true if the interface is a controller.
*/
@@ -72,6 +75,8 @@
}
/**
+ * Provides the list of server interfaces description implemented by the
+ * current Fractal component.
* @return the list of server interfaces (without controllers).
*/
protected List getFcInterfaces() {
@@ -86,6 +91,8 @@
}
/**
+ * Provides an iterator for the server interfaces descriptors of the
current
+ * Fractal component.
* @return An iterator on the server interfaces.
*/
protected Iterator interfaceIterator() {
@@ -93,14 +100,21 @@
}
/**
- * @return true if the component has server interfaces (controllers are
not considered).
+ * Checks if the current Fractal component implements some Fractal
+ * interfaces (controllers are not considered).
+ * @return true if the component has server interfaces (controllers are
not
+ * considered).
*/
protected boolean ifHasInterfaces() {
try {
return !getFcInterfaces().isEmpty();
} catch (NullPointerException ex) { return false; }
}
-
+
+ /**
+ * Checks if the current Fractal component extends another Fractal
component.
+ * @return true if the component extends another component.
+ */
protected boolean ifHasSuperComponent() {
try {
return (getCurrentClass().getSuperclass() != null);
@@ -109,6 +123,8 @@
/**
+ * Evaluates the body if the Fractal component implements some Fractal
server
+ * interfaces.
* @param template the url of the generated file.
* @throws XDocletException
* @doc.tag type="block"
@@ -118,6 +134,7 @@
}
/**
+ * Evaluates the body if the Fractal component uses an attribute
controller.
* @param template the url of the generated file.
* @throws XDocletException
* @doc.tag type="block"
@@ -157,6 +174,8 @@
/**
+ * Iterates over all implemented server interfaces if value for the
class
+ * tag equals the specified value.
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @throws XDocletException
@@ -179,6 +198,8 @@
}
/**
+ * Iterates over all implemented server interfaces if value for the
class
+ * tag does not equal the specified value.
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @throws XDocletException
@@ -202,6 +223,8 @@
}
/**
+ * Returns the not-fully-qualified name of the current component without
the
+ * package name.
* @return the short name of the component.
* @throws XDocletException
* @doc.tag type="content"
@@ -211,6 +234,7 @@
}
/**
+ * Returns the full-qualified name of the current component.
* @return the full component name
* @throws XDocletException
* @doc.tag type="content"
@@ -220,6 +244,8 @@
}
/**
+ * Returns the not-fully-qualified identifier of the current interface
+ * without the package name.
* @return return the default name of the interface.
* @throws XDocletException
* @doc.tag type="content"
@@ -229,6 +255,8 @@
}
/**
+ * Returns the full-qualified name of the attribute controller interface
+ * of the current component.
* @return the full classname of the interface implementing the
AttributeController
* @throws XDocletException
* @doc.tag type="content"
@@ -244,7 +272,9 @@
}
/**
- * @param current
+ * Append the XClass definition to the buffer if value for the class
+ * tag does not equal the specified value.
+ * @param current the Xclass to read.
* @param buffer the buffer to fill.
* @param attributes the attributes
* @throws XDocletException
@@ -259,7 +289,9 @@
}
/**
- * @return
+ * Returns a comma separated list of component descriptions used for the
+ * extend clause of the current description.
+ * @return a comma separated list of component descriptions.
* @param attributes
* @throws XDocletException
* @doc.tag type="content"
@@ -277,6 +309,7 @@
}
/**
+ * Evaluates the body if the Fractal component uses an attribute
controller.
* @param template the url of the generated file.
* @param attributes
* @throws XDocletException
@@ -297,6 +330,8 @@
/**
+ * Append the XField definition to the buffer if value for the class
+ * tag does not equal the specified value.
* @param current
* @param buffer the buffer to fill.
* @param attributes the attributes
@@ -312,6 +347,8 @@
}
/**
+ * Returns a comma separated list of argument name used for configuring
the
+ * current component.
* @return
* @param attributes
* @throws XDocletException
Index: fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/package.html
diff -u /dev/null
fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/package.html:1.1
--- /dev/null Mon Dec 20 16:27:23 2004
+++ fractal-xdoclet/src/java/org/objectweb/fractal/xdoclet/package.html Mon
Dec 20 16:27:23 2004
@@ -0,0 +1,28 @@
+<!-- ==================================================================== -->
+<!-- GoTM: GoTM is an open Transaction Monitor -->
+<!-- Contact: gotm-team@xxxxxxxxxxxxx -->
+<!-- This library is free software; you can redistribute it and/or -->
+<!-- modify it under the terms of the GNU Lesser General Public -->
+<!-- License as published by the Free Software Foundation; either -->
+<!-- version 2.1 of the License, or any later version. -->
+<!-- This library is distributed in the hope that it will be useful, -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -->
+<!-- Lesser General Public License for more details. -->
+<!-- You should have received a copy of the GNU Lesser General Public -->
+<!-- License along with this library; if not, write to the Free Software -->
+<!-- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -->
+<!-- USA -->
+<!-- Initial developer(s): Romain Rouvoy. -->
+<!-- Contributor(s): ______________________________________. -->
+<!-- $Id: package.html,v 1.1 2004/12/20 15:27:23 rouvoy Exp $ -->
+<!-- ==================================================================== -->
+<html>
+ <head>
+ <title>Fractal XDoclet Library.</title>
+ </head>
+ <body>
+ <p> Basic XDoclet Library to handle definition of Fractal Applications.
</p>
+ <p> This package includes Antsubtask and XDoclet handler definitions.
</p>
+ </body>
+</html>
\ No newline at end of file
| <-- Date Index --> | <-- Thread Index --> |
Powered by MHonArc.
Copyright © 2006-2007, OW2 Consortium | contact | webmaster.