cvs commit: jakarta-commons-sandbox/clazz/xdocs index.xml
scolebourne2004/02/28 09:20:16 Modified:compress/xdocs index.xml clazz/xdocs index.xml Log: Add status subsection around status Revision ChangesPath 1.3 +2 -0 jakarta-commons-sandbox/compress/xdocs/index.xml Index: index.xml === RCS file: /home/cvs/jakarta-commons-sandbox/compress/xdocs/index.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- index.xml 28 Feb 2004 16:07:04 - 1.2 +++ index.xml 28 Feb 2004 17:20:16 - 1.3 @@ -21,6 +21,7 @@ It has migrated via:br / Ant - Avalon-Excalibur - Commons-IO - Commons-Compress. /p +subsection name=Status p ul liThis code is in the commons isandbox/i/li @@ -29,6 +30,7 @@ liIf you like the code and want to push it towards a release, join the mailing list!/li /ul /p +/subsection /section section name=Documentation 1.5 +10 -8 jakarta-commons-sandbox/clazz/xdocs/index.xml Index: index.xml === RCS file: /home/cvs/jakarta-commons-sandbox/clazz/xdocs/index.xml,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- index.xml 20 Feb 2004 01:06:47 - 1.4 +++ index.xml 28 Feb 2004 17:20:16 - 1.5 @@ -34,14 +34,6 @@ All help is gratefully received. /p p - ul - liThis code is in the commons isandbox/i/li - liThe code is unreleased/li - liMethods and classes can and will appear and disappear without warning/li - liIf you like the code and want to push it towards a release, join the mailing list!/li - /ul -/p -p The initial list of requirements driving the design was: ul liHandle all classes, not just beans/li @@ -53,6 +45,16 @@ liBe simple to learn/li /ul /p +subsection name=Status +p + ul + liThis code is in the commons isandbox/i/li + liThe code is unreleased/li + liMethods and classes can and will appear and disappear without warning/li + liIf you like the code and want to push it towards a release, join the mailing list!/li + /ul +/p +/subsection /section - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: jakarta-commons-sandbox/clazz/xdocs index.xml
scolebourne2004/02/19 17:06:47 Modified:clazz/xdocs index.xml Log: Fix spaces issue Revision ChangesPath 1.4 +2 -2 jakarta-commons-sandbox/clazz/xdocs/index.xml Index: index.xml === RCS file: /home/cvs/jakarta-commons-sandbox/clazz/xdocs/index.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- index.xml 20 Feb 2004 00:35:32 - 1.3 +++ index.xml 20 Feb 2004 01:06:47 - 1.4 @@ -30,7 +30,7 @@ Commons-Clazz is an upgrade to reflection and introspection. It was born in response to the lack of improvements in handling JavaBeans by the JDK, such as no specification to cover List and Map access to and from beans. -See the a href=userguide.htmluserguide/a for more details of the design adopted. +See the a href=userguide.htmluser guide/a for more details of the design adopted. All help is gratefully received. /p p @@ -59,7 +59,7 @@ section name=Documentation p ul - liThe clazz a href=userguide.htmluserguide/a is available/li + li The clazz a href=userguide.htmluser guide/a is available/li liThe a href=apidocs/index.htmlJavadoc/a of the latest CVS/li liThe a href=http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/clazz/;CVS repository/a can be browsed./li /ul - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: jakarta-commons-sandbox/clazz/xdocs index.xml
dirkv 2003/11/17 13:41:27
Added: clazz/xdocs index.xml
Log:
copy of overview.xml to have something on the homepage
Revision ChangesPath
1.1 jakarta-commons-sandbox/clazz/xdocs/index.xml
Index: index.xml
===
?xml version=1.0 encoding=UTF-8?
document
properties
title
Clazz Overview
/title
author email=[EMAIL PROTECTED]
Dmitri Plotnikov
/author
/properties
body
section name=Clazz
p
Clazz is an upgrade to the Java Beans mechanisms, reflecting new
requirements, new de facto standards and a wider range of potential
applications.
/p
ul
lia href=#RequirementsRequirements/a
ul
lia href=#Project Contributed RequirementsProject Contributed
Requirements/a
/li
/ul
/li
!--
lia href=#Clazz ClassClazz Class/a
/li
lia href=#Client Side of ClazzClient Side of Clazz/a
ul
lia href=#Description ProviderDescription Provider/a/li
lia href=#Metadata ProviderMetadata Provider/a/li
/ul
/li
--
/ul
/section
section name=Requirements
p
Introduced by Stephen Colebourne, here's the initial list of
requirements (lifted from PROPOSAL.html):
/p
p
The package should:
/p
p
ul
liHandle all classes, not just beans/li
liSupport extensible metadata (not just for GUI builders)/li
liHandle normal (today) bean conventions (get/set/add/put methods)/li
liHandle future conventions that are not yet standard/li
liSupport method overloading/li
liProvide a complete alternative to using java.beans.Introspector/li
liBe simple to learn/li
/ul
/p
subsection name=Project Contributed Requirements
p
lt;TBDgt; - requirements contributed by potential users of clazz
go here.
/p
/subsection
/section
section name=Clazz Class
p
The best way to introduce the Clazz class is by comparing it to the
java.lang.Class class. Though both serve the same function as runtime
meta-data about a type, there are several important differences:
ul
li
Class is a final class embedded in the JVM. Its behavior cannot be
customized or enhanced. Clazz is an abstract class
and allows many alternative implementations.
/li
li
Class describes a Java type in terms of fields, methods and
constructors.
Clazz describes a type in terms of properties, operations
and instance factories. In the case when a Clazz represents a Java
class,
those properties, operations and instance factories may or may not map
directly to fields, methods and constructors. The mapping is determined
by the
implementation of the Clazz and can be quite non-trivial. For example,
a Clazz may map pairs of Java methods like getFoo() and setFoo() to a
single property called foo. There may be many ways to describe the same
Java class with a Clazz.
/li
li
Class is restricted to describing Java types.
Clazz does not have that limitation. A Clazz can be created dynamically
out
of piece parts.
/li
/ul
/p
/section
section name=Client Side of Clazz
p
The client sees Clazz as a set of interfaces.
The following code illustrates a basic interaction between a
client and the Clazz package:
/p
!-- + SOURCE + --
source
b/
public class MyExample1 {
void listAllOperations(){
// Step 1. Obtain the ClazzLoader associated with the default
// clazz model. Provide a ClassLoader as a context
// for reflection.
ClazzLoader clazzLoader =
Clazz.getDefaultClazzLoader(MyExample1.class.getClassLoader());
// Step 2. Find the Clazz
Clazz clazz = clazzLoader.getClazzForName(my.example.Example);
// Step 3. Obtain operation descriptions from the clazz
List operations = clazz.getOperations();
for (Iterator iter = operations.iterator(); iter.hasNext();) {
ClazzOperation operation = (ClazzOperation) iter.next();
System.out.println(Operation: +
