Package org.apache.pinot.spi.annotations

Class InterfaceStability

java.lang.Object

org.apache.pinot.spi.annotations.InterfaceStability

@Public
@Evolving
public class InterfaceStability
extends Object

Annotation to inform users of how much to rely on a particular package, class or method not changing over time. Currently the stability can be InterfaceStability.Stable, InterfaceStability.Evolving or InterfaceStability.Unstable.

• All classes that are annotated with InterfaceAudience.Public must have InterfaceStability annotation.
• Classes that are InterfaceAudience.Private are to be considered unstable unless a different InterfaceStability annotation states otherwise.
• Pinot contributors should NOT make incompatible changes to classes marked as stable. Some things to watch out for classes marked as stable:
  • Method(s) cannot be removed from classes/interfaces marked as stable during minor version releases. Deprecate the method(s) first and remove the method in a major release.
  • Similar to earlier point, method signature cannot change.
  • New methods cannot be added to interfaces without providing default implementation for minor version releases.

Note: the definitions are borrowed from a similar annotation from Apache Hadoop project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InterfaceStability.Evolving	Evolving, but can break compatibility at minor release (i.e.
static interface	InterfaceStability.Stable	Can evolve while retaining compatibility for minor release boundaries.; can break compatibility only at major release (ie.
static interface	InterfaceStability.Unstable	No guarantee is provided as to reliability or stability across any level of release granularity.

Constructor Summary

Constructors

Constructor	Description
InterfaceStability()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InterfaceStability

public InterfaceStability()