Definir restricciones de API

Las Herramientas de API proporcionan códigos Javadoc para documentar y restringir explícitamente la utilización de las API. Las tablas siguientes proporcionan un resumen de los códigos Javadoc soportados por cada miembro y la semántica de cada código.

Un cliente hace referencia a un plug-in o un paquete necesario para el paquete en el que está definida la API asociada. Las restricciones no se aplican en el mismo paquete en el que está definida la API. Por ejemplo, un paquete que define una interfaz como @noimplement también puede proporcionar una implementación de esa interfaz.

Códigos de restricción soportados

  Clase Interfaz Método Constructor

Campo final

Campo no final
@noimplement
-
Soportado
-
-
-
-
@noextend
Soportado
Soportado
-
-
-
-
@noinstantiate
Soportado
-
-
-
-
-
@nooverride
-
-
Soportado
-
-
-
@noreference
-
-
Soportado
Soportado
-
Soportado

Semántica de restricción

@noimplement

Indica que los clientes no deben implementar esta interfaz. Cualquier clase que utilice la palabra clave implements para la interfaz asociada o para el padre de la interfaz asociada en las que no haya superclases de implementación será distinguida con un problema.

@noextend
Indica que los clientes no deben ampliar esta clase o interfaz. Las clases o interfaces que utilicen la palabra clave extends para el tipo asociado serán distinguidas con un problema.
@noinstantiate
Indica que los clientes no deben crear una instancia de esta clase. Cualquier código que cree una instancia de la clase con cualquier constructor será distinguido con un problema.
@nooverride
Indica que los clientes no deben redeclarar este método. Cualquier subclase que defina un método que altera temporalmente el método asociado se marcará con un problema.
@noreference
Indica que los clientes no deben hacer referencia a este método, constructor o campo no final. Cualquier código que invoque directamente el método o el constructor asociado o haga referencia al campo no final asociado se distinguirá con un problema.

Tareas relacionadas

Configurar una línea base

Consulta relacionada

Gestión del código @since Javadoc
Preferencias de líneas base de API
Preferencias de errores y avisos de API