Package org.pjdbc.annotations

Annotation Interface DriverDependency

@Documented @Retention(RUNTIME) @Target(TYPE) @Repeatable(DriverDependencies.class) public @interface DriverDependency
Declares an external dependency required by a PJDBC proxy driver.

This annotation is repeatable, allowing multiple dependencies to be declared on a single driver class. Dependencies are typically optional Maven artifacts that must be present at runtime for the driver to function.

Example usage:


 @DriverCapability(prefix = "hikaricp", description = "HikariCP connection pooling")
 @DriverDependency(
     groupId = "com.zaxxer",
     artifactId = "HikariCP",
     version = "5.1.0"
 )
 public class HikariPoolDriver extends AbstractProxyDriver {
     // ...
 }
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    artifactId
    The Maven artifact ID of the dependency.
    String
    groupId
    The Maven group ID of the dependency.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    A description of why this dependency is needed.
    boolean
    optional
    Whether this dependency is optional.
    String
    version
    The recommended version of the dependency.

  • Element Details

    • groupId

      String groupId
      The Maven group ID of the dependency.
      Returns:
      the group ID (e.g., "com.zaxxer")

    • artifactId

      String artifactId
      The Maven artifact ID of the dependency.
      Returns:
      the artifact ID (e.g., "HikariCP")

    • version

      String version
      The recommended version of the dependency. This is informational and may not reflect the exact version used.
      Returns:
      the version (e.g., "5.1.0")
      Default:
      ""

    • optional

      boolean optional
      Whether this dependency is optional. Optional dependencies are not required at runtime but enable additional functionality when present.
      Returns:
      true if the dependency is optional
      Default:
      true

    • description

      String description
      A description of why this dependency is needed.
      Returns:
      the dependency description
      Default:
      ""