Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document provides:

  • A set of guidelines intended to help the Apache Juneau team balance the need to provide a stable interface to clients with the growth and evolution of components over time.
  • A language for describing the changes to a component and the types of incompatibilities such changes may create.
  • A protocol for communicating those changes and incompatibilities to users and developers.

Table of Contents

1 - Interface Types

We identify two distinct categories of APIs within a component: externalinternal.

 1.1 - The External Interface

 Composed of the public-facing classes, methods and fields that are likely to be consumed by external developers.  In general, these consist of all public classes/methods/fields, and protected methods/fields on classes meant to be extended.

...