[jdom-interest] Javadoc suggestion for Element.java

Jools Enticknap jools at jools.org
Tue Jun 13 06:46:51 PDT 2000

Here is a short text which I feel might be of use to programmers who
might want to subclass Element.

If this seems reasonable, perhaps a small peice of text for the other
default constrcutors might be helpfull too.

 * <p>
 * This constructor is supplied specifically for use by users who need to
 * implement their own Element.
 * </p>
 * <p>
 * It should be noted by implementors that simply calling super() in 
 * classes dirived from <code>Element</code> will not initialize any
 * of the instance variables which will cause many of the method to
 * throw a <code>{@link NullPointerException>}</code>. 
 * It is therefore suggested that the implementor calls one of the
 * no-default constructors in order to guarantee a spec compliant 
 * <code>Element<code>.
 * If it is not possible to call one of the non-default constructors
 * it is suggest that the implementor read the code for the 
 * <code>@link{Element( String, Namespace)}</code> constructor.
 * </p?

More information about the jdom-interest mailing list