Merge pull request #7 from Saxonica/method-fixes

Method fixes

Author: ndw

README.md

@@ -120,4 +120,18 @@ incomplete or incorrect, please [open an issue](https://github.com/Saxonica/xmld
 
 ## Change log
 
+* **0.6.0** Improved handling of method names and inheritance
+  
+  Changed the “name” of methods to include the parameter types. (i.e., `foo(int)`
+  instead of `foo`). This allows them to be distinguished.
+  
+  Fixed a bug where the methods inherited from interfaces were not shown.
+  
+  Fixed a bug in computing visibility. Previously, the code looked for an explicit
+  ~public~ or ~protected~ modifier. Now it *excludes* things explicitly marked ~private~.
+  
+  Experimentally removed ~java.lang.Object~ as a supertype in the generated XML.
+
+The previous version looked for methods and fields marked as public or protected, but that's not the same thing!
+
 * **0.5.0** String constants now use “backslash-U” escapes for non-ASCII characters.

gradle.properties

@@ -1,4 +1,4 @@
-docletVersion=0.5.0
-schemaVersion=0.5.0
+docletVersion=0.6.0
+schemaVersion=0.6.0
 docletTitle=XmlDoclet
 docletName=xmldoclet

sample/src/main/java/org/example/AbstractClass.java

@@ -1,4 +1,13 @@
 package org.example;
 
 abstract public class AbstractClass implements TestInterface {
+    abstract void one(int value);
+    abstract void one(int value, int otherValue);
+    abstract void one(String value);
+    public void foo() {
+        System.err.println("impl in AbstractClass");
+    }
+    public void inAbsr() {
+        System.err.println("impl in AbstractClass");
+    }
 }

sample/src/main/java/org/example/AlternateImplementation.java

@@ -0,0 +1,23 @@
+package org.example;
+
+public class AlternateImplementation extends Implementation {
+    @Override
+    void one(int value, int otherValue) {
+        System.err.println("alternate: " + value + ", " + otherValue);
+    }
+
+    @Override
+    void one(String value) {
+        // nop
+    }
+
+    @Override
+    public void foo() {
+        System.err.println("alternate foo");
+    }
+
+    @Override
+    public void baz() {
+        System.err.println("alternate baz");
+    }
+}

sample/src/main/java/org/example/AxisIterator.java

@@ -0,0 +1,6 @@
+package org.example;
+
+public interface AxisIterator extends SequenceIterator {
+    @Override
+    String next();
+}

sample/src/main/java/org/example/EmptyIterator.java

@@ -0,0 +1,17 @@
+package org.example;
+
+public class EmptyIterator implements SequenceIterator {
+    @Override
+    public Object next() {
+        return null;
+    }
+
+    private static class OfNodes extends EmptyIterator implements AxisIterator {
+
+        public final static OfNodes THE_INSTANCE = new OfNodes();
+        @Override
+        public String next() {
+            return null;
+        }
+    }
+}

sample/src/main/java/org/example/Implementation.java

@@ -1,6 +1,6 @@
 package org.example;
 
-public class Implementation extends AbstractClass {
+public abstract class Implementation extends AbstractClass {
     @Override
     public void foo() {
         // nop
@@ -10,4 +10,18 @@ public void foo() {
     public void bar() {
         // nop
     }
+
+    @Override
+    void one(int value) {
+        System.err.println("int: " + value);
+    }
+
+    @Override
+    void one(int value, int otherValue) {
+        System.err.println("int: " + value + ", " + otherValue);
+    }
+
+    void inImpl() {
+        System.err.println("In impl");
+    }
 }

sample/src/main/java/org/example/IterImpl.java

@@ -0,0 +1,18 @@
+package org.example;
+
+public class IterImpl implements SequenceIterator {
+    @Override
+    public boolean hasNext() {
+        return false;
+    }
+
+    @Override
+    public Object next() {
+        return null;
+    }
+
+    @Override
+    public void close() {
+        // nop
+    }
+}

sample/src/main/java/org/example/ParameterizedClass.java

@@ -0,0 +1,8 @@
+package org.example;
+
+public class ParameterizedClass<T> {
+    private T[] _value;
+    public T get(int key) {
+        return _value[key];
+    }
+}

sample/src/main/java/org/example/SequenceIterator.java

@@ -0,0 +1,8 @@
+package org.example;
+
+import java.io.Closeable;
+
+public interface SequenceIterator extends Closeable  {
+    public Object next();
+    default void close() {}
+}

sample/src/main/java/org/example/TestClass.java

@@ -5,6 +5,7 @@
 import net.sf.saxon.lib.Feature;
 import net.sf.saxon.serialize.charcode.CharacterSet;
 
+import java.lang.reflect.Parameter;
 import java.util.*;
 
 /**
@@ -13,12 +14,19 @@
 
 public class TestClass implements CharacterSet {
     public static final TestClass CONSTANTVALUE = new TestClass();
+    protected ParameterizedClass<String> stringParameterizedClass = new ParameterizedClass<>();
 
     /** The tick! With {@value}*/
     protected final int spoon = 17;
 
     private static final TestClass theInstance = new TestClass();
 
+    /**
+     * Constant indicating 1.0
+     */
+
+    public static final int XML10 = 10;
+
     /**
      * Private constructor to force the singular instance to be used
      */

sample/src/main/java/org/example/TestInterface.java

@@ -12,4 +12,5 @@ public interface TestInterface {
      * <p>See also {@link #foo()}.</p>
      */
     void bar();
+    void baz();
 }

xmldoclet/src/main/java/com/saxonica/xmldoclet/scanners/XmlExecutableElement.java

@@ -25,7 +25,7 @@ public void scan(DocTree tree) {
 
         // Hack
         if (!"constructor".equals(typeName())) {
-            attr.put("name", element.getSimpleName().toString());
+            attr.put("name", element.toString());
         }
 
         Map<String,DeclaredType> thrownTypes = new HashMap<>();

xmldoclet/src/main/java/com/saxonica/xmldoclet/scanners/XmlTypeElement.java

@@ -76,6 +76,13 @@ public void scan(DocTree tree) {
     }
 
     private void showSuperclass(TypeElement element, DeclaredType superclass, Implemented impl) {
+        if (element.getSuperclass() instanceof DeclaredType) {
+            String name = ((DeclaredType) element.getSuperclass()).toString();
+            if ("java.lang.Object".equals(name)) {
+                return;
+            }
+        }
+
         builder.startElement("superclass");
         TypeUtils.xmlType(builder, "type", element.getSuperclass());
 
@@ -84,7 +91,7 @@ private void showSuperclass(TypeElement element, DeclaredType superclass, Implem
         List<Element> inherited = new ArrayList<>();
         for (Element elem : enclosed) {
             String name = elem.toString();
-            if (elem.getModifiers().contains(Modifier.PUBLIC) || elem.getModifiers().contains(Modifier.PROTECTED)) {
+            if (!elem.getModifiers().contains(Modifier.PRIVATE)) {
                 if (elem.getKind() == ElementKind.FIELD) {
                     if (!impl.fields.contains(name)) {
                         impl.fields.add(name);
@@ -104,7 +111,7 @@ private void showSuperclass(TypeElement element, DeclaredType superclass, Implem
             builder.startElement("inherited");
             for (Element elem : inherited) {
                 Map<String, String> amap = new HashMap<>();
-                amap.put("name", elem.getSimpleName().toString());
+                amap.put("name", elem.toString());
                 if (elem.getKind() == ElementKind.FIELD) {
                     builder.startElement("field", amap);
                     builder.endElement("field");
@@ -123,21 +130,6 @@ private void showSuperclass(TypeElement element, DeclaredType superclass, Implem
 
             showInterfaces(setype, impl);
 
-/*
-
-            if (!setype.getInterfaces().isEmpty()) {
-                builder.startElement("interfaces");
-                for (TypeMirror tm : setype.getInterfaces()) {
-                    if (tm.getKind() == TypeKind.DECLARED) {
-                        DeclaredType dtm = (DeclaredType) tm;
-                        System.err.println(dtm);
-                    }
-                    TypeUtils.xmlType(builder, "interfaceref", tm);
-                }
-                builder.endElement("interfaces");
-            }
- */
-
             if (sstype.getKind() == TypeKind.DECLARED) {
                 showSuperclass(setype, (DeclaredType) sstype, impl);
             }
@@ -171,6 +163,14 @@ private void showInterfaces(TypeElement element, Implemented impl) {
                         builder.startElement("field", amap);
                         builder.endElement("field");
                     }
+                    if (celem.getKind() == ElementKind.METHOD) {
+                        if (!impl.methods.contains(celem.toString())) {
+                            amap = new HashMap<>();
+                            amap.put("name", celem.toString());
+                            builder.startElement("method", amap);
+                            builder.endElement("method");
+                        }
+                    }
                 }
 
                 showInterfaces(ttm, impl);
@@ -181,7 +181,9 @@ private void showInterfaces(TypeElement element, Implemented impl) {
 
     private void updateImplemented(TypeElement element, Implemented impl) {
         for (Element elem : element.getEnclosedElements()) {
-            if (elem.getModifiers().contains(Modifier.PUBLIC) || elem.getModifiers().contains(Modifier.PROTECTED)) {
+            Set<Modifier> modifiers = elem.getModifiers();
+            if (!(modifiers.contains(Modifier.PRIVATE))) {
+                ElementKind kind = elem.getKind();
                 if (elem.getKind() == ElementKind.FIELD) {
                     impl.fields.add(elem.toString());
                 }