You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by do...@apache.org on 2002/11/16 12:37:06 UTC
cvs commit: jakarta-avalon/src/documentation/content/xdocs/developing changes.xml compatiblity.xml conclusion.xml decomposing.xml framework.xml implementing.xml index.xml introduction.xml
donaldp 2002/11/16 03:37:06
Modified: src/documentation/content/xdocs/developing Tag:
FORREST-branch changes.xml compatiblity.xml
conclusion.xml decomposing.xml framework.xml
implementing.xml index.xml introduction.xml
Log:
Add DOCTypes that use a uri
Revision Changes Path
No revision
No revision
1.1.2.2 +2 -2 jakarta-avalon/src/documentation/content/xdocs/developing/Attic/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/documentation/content/xdocs/developing/Attic/changes.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- changes.xml 16 Nov 2002 09:40:06 -0000 1.1.2.1
+++ changes.xml 16 Nov 2002 11:37:05 -0000 1.1.2.2
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE revhistory PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
- "./dtd/docbookx.dtd">
+<!DOCTYPE revhistory PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<revhistory>
<revision revisionflag="fixed">
1.1.2.2 +44 -44 jakarta-avalon/src/documentation/content/xdocs/developing/Attic/compatiblity.xml
Index: compatiblity.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/documentation/content/xdocs/developing/Attic/compatiblity.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- compatiblity.xml 16 Nov 2002 09:40:06 -0000 1.1.2.1
+++ compatiblity.xml 16 Nov 2002 11:37:05 -0000 1.1.2.2
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
- "./dtd/docbookx.dtd">
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
xml:base="context://content/xdocs/developing/">
@@ -15,70 +15,70 @@
How to make your project compatible with an Avalon Containers.
</subtitle>
<para>
- There are many applications, utility or tools written in Java that you
- wish you could use in an Avalon container. It may be that you are
- writing such an app/utility/tool that you intend to additionally be
- usable by Avalon components in Avalon containers. This document
- gives some advice on the subject. We will refer to applications,
- utilities and tools as just 'tools' from her on in. We'll assume
- the classes for which are in a single Jar.
+ There are many applications, utility or tools written in Java that you
+ wish you could use in an Avalon container. It may be that you are
+ writing such an app/utility/tool that you intend to additionally be
+ usable by Avalon components in Avalon containers. This document
+ gives some advice on the subject. We will refer to applications,
+ utilities and tools as just 'tools' from her on in. We'll assume
+ the classes for which are in a single Jar.
</para>
- <para>
+ <para>
This advise is applicable to all
<a href="../framework/reference-containers.html">reference containers</a>
</para>
<section>
<title>Making a Jar for a tool</title>
<para>
- The tool's Jar should only contain the classes in question and
- directly associated resources. It should not contain the classes
- or resources from other projects. For example it is a bad habit
- to include the org.apache.xerces.* jars in another jar. It would
- be correct for the notes accompanying the tools to list xerces.jar
+ The tool's Jar should only contain the classes in question and
+ directly associated resources. It should not contain the classes
+ or resources from other projects. For example it is a bad habit
+ to include the org.apache.xerces.* jars in another jar. It would
+ be correct for the notes accompanying the tools to list xerces.jar
as a dependency.
</para>
- <para>
- It is best that packages for the tool are well defined. Sun
- recommend a package structure that honors the internet domain of
+ <para>
+ It is best that packages for the tool are well defined. Sun
+ recommend a package structure that honors the internet domain of
the hosted proejct. For example org.apache prefixes all the packages
- of projects hosted at Apache. Sometimes a project thinks it is
- significant enough to avoid the domain name based naming, but still
- have a package. JUnit is an example of this, as it uses junit as its
+ of projects hosted at Apache. Sometimes a project thinks it is
+ significant enough to avoid the domain name based naming, but still
+ have a package. JUnit is an example of this, as it uses junit as its
top level package. Tools that have no package or a package name
that a non unique word are not good design.
</para>
- </section>
+ </section>
<section>
<title>Wrapping third party tools</title>
<para>
- There are many tools written in Java as beans that you wish you could
- use in an Avalon container as a component. If they are not
- dependent on Avalon packages and classes already it is likely that
- some wrapper concept is appropriate. The normal form is to have
- a separate package with a class that is dependent on Avalon Framework
- methods. That wrapper class would be Configurable, Initializable etc,
+ There are many tools written in Java as beans that you wish you could
+ use in an Avalon container as a component. If they are not
+ dependent on Avalon packages and classes already it is likely that
+ some wrapper concept is appropriate. The normal form is to have
+ a separate package with a class that is dependent on Avalon Framework
+ methods. That wrapper class would be Configurable, Initializable etc,
and would map its configuration to setZYZ() methods in the original bean.
</para>
<para>
- It is also a good idea to understand the
- <a href="../framework/guide-patterns-soii.html">separation of interface
+ It is also a good idea to understand the
+ <a href="../framework/guide-patterns-soii.html">separation of interface
and implementation</a> when designing components.
</para>
- </section>
+ </section>
<section>
<title>Dynamic Classloading</title>
<para>
- Many Java tools internally use
- <emphasis>Class.forName(String).newInstance()</emphasis>
+ Many Java tools internally use
+ <emphasis>Class.forName(String).newInstance()</emphasis>
to instantiate some part of its internal functionality. This
- works if the class's Jar is mounted at the top-level system
- classloader. In the case of many Avalon containers, the Jar in
+ works if the class's Jar is mounted at the top-level system
+ classloader. In the case of many Avalon containers, the Jar in
question will actually be mounted in a classloader at some other point
- in a tree of classloaders. Thus <emphasis>Class.forName()</emphasis>
- will fail with ClassNotFoundException if running in a container.
+ in a tree of classloaders. Thus <emphasis>Class.forName()</emphasis>
+ will fail with ClassNotFoundException if running in a container.
</para>
<para>
- A better thing to do would be to use
+ A better thing to do would be to use
<emphasis>this.getClass().getClassLoader().loadClass(String)</emphasis>.
This means that the class will always be loaded from classloader
that hosts the rest of the classes for the tool. It can run at any
@@ -88,17 +88,17 @@
<section>
<title>Use of Static</title>
<para>
- It is common amongst novice developers to use much static
- functionality. This could be methods or class variables. Given
+ It is common amongst novice developers to use much static
+ functionality. This could be methods or class variables. Given
that Avalon's containers may mount multiple instances of a component
potentially in multiple classloaders, the use of static may lead to
- unpredicted behavior. If the static var or method is mounted in a
- classloader that is visible to multiple components, then it will
- behave as expected. For this reason, static should be used with care
+ unpredicted behavior. If the static var or method is mounted in a
+ classloader that is visible to multiple components, then it will
+ behave as expected. For this reason, static should be used with care
- you cannot guarantee where someone might try to run your tool.
</para>
<para>
- Static also makes Unit Testing quite difficult. If you can at all
+ Static also makes Unit Testing quite difficult. If you can at all
avoid it, please do so.
</para>
</section>
1.1.2.2 +3 -3 jakarta-avalon/src/documentation/content/xdocs/developing/Attic/conclusion.xml
Index: conclusion.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/documentation/content/xdocs/developing/Attic/conclusion.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- conclusion.xml 16 Nov 2002 09:40:06 -0000 1.1.2.1
+++ conclusion.xml 16 Nov 2002 11:37:05 -0000 1.1.2.2
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
- "./dtd/docbookx.dtd">
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
xml:base="context://content/xdocs/developing/">
@@ -123,7 +123,7 @@
you to use now. They are mature and only getting better. While
Avalon Phoenix and Avalon Cornerstone are under heavy development,
anything you write for them will be usable with only minor
- modifications in the future.
+ modifications in the future.
</para>
</section>
</chapter>
1.1.2.2 +3 -3 jakarta-avalon/src/documentation/content/xdocs/developing/Attic/decomposing.xml
Index: decomposing.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/documentation/content/xdocs/developing/Attic/decomposing.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- decomposing.xml 16 Nov 2002 09:40:06 -0000 1.1.2.1
+++ decomposing.xml 16 Nov 2002 11:37:05 -0000 1.1.2.2
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
- "./dtd/docbookx.dtd">
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
xml:base="context://content/xdocs/developing/">
@@ -285,7 +285,7 @@
function or action of a role. Just like the theatrical version, the
script determines how you interact with the Component. Think of the
different roles in your system, and you will have your
- <emphasis>cast</emphasis> of Components so to speak.
+ <emphasis>cast</emphasis> of Components so to speak.
</para>
<para>
A role is the contract for a type of component. For example, our
1.1.2.2 +2 -2 jakarta-avalon/src/documentation/content/xdocs/developing/Attic/framework.xml
Index: framework.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/documentation/content/xdocs/developing/Attic/framework.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- framework.xml 16 Nov 2002 09:40:06 -0000 1.1.2.1
+++ framework.xml 16 Nov 2002 11:37:05 -0000 1.1.2.2
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
- "./dtd/docbookx.dtd">
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
xml:base="context://content/xdocs/developing/">
1.1.2.2 +3 -3 jakarta-avalon/src/documentation/content/xdocs/developing/Attic/implementing.xml
Index: implementing.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/documentation/content/xdocs/developing/Attic/implementing.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- implementing.xml 16 Nov 2002 09:40:06 -0000 1.1.2.1
+++ implementing.xml 16 Nov 2002 11:37:05 -0000 1.1.2.2
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
- "./dtd/docbookx.dtd">
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
xml:base="context://content/xdocs/developing/">
@@ -1020,7 +1020,7 @@
<section>
<title>Collection Utilities</title>
<para>
- The collection utilities provide some enhancements to the
+ The collection utilities provide some enhancements to the
<trademark>Java</trademark> Collections API. Among them is the ability
to find the intersections between two lists and a
<classname>PriorityQueue</classname> that is an enhancement to
1.1.2.2 +2 -2 jakarta-avalon/src/documentation/content/xdocs/developing/Attic/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/documentation/content/xdocs/developing/Attic/index.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- index.xml 16 Nov 2002 09:40:06 -0000 1.1.2.1
+++ index.xml 16 Nov 2002 11:37:05 -0000 1.1.2.2
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
- "./dtd/docbookx.dtd">
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<book xmlns:xi="http://www.w3.org/2001/XInclude"
xml:base="context://content/xdocs/developing/">
1.1.2.2 +2 -2 jakarta-avalon/src/documentation/content/xdocs/developing/Attic/introduction.xml
Index: introduction.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/documentation/content/xdocs/developing/Attic/introduction.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- introduction.xml 16 Nov 2002 09:40:06 -0000 1.1.2.1
+++ introduction.xml 16 Nov 2002 11:37:05 -0000 1.1.2.2
@@ -1,7 +1,7 @@
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
- "./dtd/docbookx.dtd">
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
xml:base="context://content/xdocs/developing/">
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>