javadoc

Author: mcculls

class-match/src/main/java/datadog/instrument/classmatch/ClassFile.java

@@ -38,12 +38,22 @@ public final class ClassFile {
 
   private ClassFile() {}
 
-  /** Extracts a {@link ClassHeader} from the given class-file content. */
+  /**
+   * Extracts a {@link ClassHeader} from the given class-file content.
+   *
+   * @param bytecode the class-file content to parse
+   * @return class header containing class-name, super-name, interfaces
+   */
   public static ClassHeader header(byte[] bytecode) {
     return parse(bytecode, true);
   }
 
-  /** Extracts a {@link ClassOutline} from the given class-file content. */
+  /**
+   * Extracts a {@link ClassOutline} from the given class-file content.
+   *
+   * @param bytecode the class-file content to parse
+   * @return class outline containing header, fields, methods, annotations
+   */
   public static ClassOutline outline(byte[] bytecode) {
     return (ClassOutline) parse(bytecode, false);
   }
@@ -52,6 +62,8 @@ public static ClassOutline outline(byte[] bytecode) {
    * Flags the given annotation as interesting; to be included in outlines.
    *
    * <p>Example: {@code ClassFile.annotationOfInterest("javax/ws/rs/Path");}
+   *
+   * @param internalName the name of the annotation type in internal form
    */
   public static synchronized void annotationOfInterest(String internalName) {
     if (annotationKeys.containsKey(internalName)) {
@@ -70,6 +82,8 @@ public static synchronized void annotationOfInterest(String internalName) {
    * Flags the given annotations as interesting; to be included in outlines.
    *
    * <p>Example: {@code ClassFile.annotationsOfInterest("javax/ws/rs/Path", "jakarta/ws/rs/Path");}
+   *
+   * @param internalNames the names of the annotation types in internal form
    */
   public static synchronized void annotationsOfInterest(Collection<String> internalNames) {
     if (annotationKeys.keySet().containsAll(internalNames)) {

class-match/src/main/java/datadog/instrument/classmatch/ClassHeader.java

@@ -13,11 +13,21 @@
 /** Minimal class header that describes its access flags and immediate class hierarchy. */
 public class ClassHeader {
 
+  /** Access modifiers for this class. */
   public final int access;
+
+  /** Internal name of this class. */
   public final String className;
+
+  /** Internal name of the super-class declared by this class. */
   public final String superName;
+
+  /** Internal names of the interfaces declared by this class. */
   final String[] interfaces;
 
+  /**
+   * @return internal names of the interfaces declared by this class.
+   */
   public List<String> interfaces() {
     return asList(interfaces);
   }

class-match/src/main/java/datadog/instrument/classmatch/ClassOutline.java

@@ -13,18 +13,32 @@
 /** Outlines a class; access flags, immediate class hierarchy, field, methods, annotations. */
 public final class ClassOutline extends ClassHeader {
 
+  /** Outlines of fields declared by this class. */
   final FieldOutline[] fields;
+
+  /** Outlines of methods declared by this class. */
   final MethodOutline[] methods;
+
+  /** Internal names of annotations declared on this class. */
   final String[] annotations;
 
+  /**
+   * @return outlines of fields declared by this class
+   */
   public List<FieldOutline> fields() {
     return asList(fields);
   }
 
+  /**
+   * @return outlines of methods declared by this class
+   */
   public List<MethodOutline> methods() {
     return asList(methods);
   }
 
+  /**
+   * @return internal names of annotations declared on this class
+   */
   public List<String> annotations() {
     return asList(annotations);
   }

class-match/src/main/java/datadog/instrument/classmatch/FieldOutline.java

@@ -9,8 +9,13 @@
 /** Outlines a field; access flags, field name, descriptor. */
 public final class FieldOutline {
 
+  /** Access modifiers for this field. */
   public final int access;
+
+  /** Name of this field. */
   public final String fieldName;
+
+  /** Descriptor containing the raw field type. */
   public final String descriptor;
 
   FieldOutline(int access, String fieldName, String descriptor) {

class-match/src/main/java/datadog/instrument/classmatch/MethodOutline.java

@@ -14,13 +14,23 @@
 /** Outlines a method; access flags, method name, descriptor, annotations. */
 public final class MethodOutline {
 
+  /** Access modifiers for this method. */
   public final int access;
+
+  /** Name of this method. */
   public final String methodName;
+
+  /** Descriptor containing the raw parameter types and return type. */
   public final String descriptor;
+
+  /** Internal names of annotations declared on this method. */
   final String[] annotations;
 
   private int[] descriptorBoundaries;
 
+  /**
+   * @return internal names of annotations declared on this method
+   */
   public List<String> annotations() {
     return asList(annotations);
   }