¿Cómo declarar o marcar un método Java como obsoleto?

Question

Me gustaría hacer que uno de mis métodos "desaprobado" = no se use nunca más.

Pero aun así me gustaría tenerlo en mi API. Solo quiero mostrar "advertencia" a cualquiera que use ese método.

¿Cómo puedo lograr eso?

Answer 1

Use @Deprecated en el método. No se olvide de aclarar campo javadoc:

/** 
* Does some thing in old style. 
* 
* @deprecated use {@link #new()} instead. 
*/ 
@Deprecated 
public void old() { 
// ... 
} 

Answer 2

Hay dos cosas que puede hacer:

1. Añadir la anotación @Deprecated al método, y
2. Añadir una etiqueta @deprecated el Javadoc del método

Debe hacer ambos!

Citando al java documentation sobre este tema:

A partir de J2SE 5.0, despreciar una clase, método o campo utilizando la anotación @Deprecated. Además, puede usar la etiqueta @deprecated Javadoc para indicar a los desarrolladores qué usar en su lugar.

Al usar la anotación, el compilador de Java genera advertencias cuando se usa la clase, el método o el campo en desuso. El compilador suprime las advertencias de desaprobación si una unidad de compilación obsoleta usa una clase, método o campo en desuso. Esto le permite construir API heredadas sin generar advertencias.

Se recomienda encarecidamente utilizar la etiqueta @deprecated de Javadoc con los comentarios apropiados que expliquen cómo utilizar la nueva API. Esto garantiza que los desarrolladores tengan una ruta de migración viable desde la antigua API a la nueva API

Answer 3

Uso del annotation@Deprecated para su método, y también se debe mencionar que en sus javadocs.

Answer 4

Eche un vistazo a la anotación @Deprecated.

Answer 5

Utilice la anotación @Deprecated y la etiqueta @deprecated JavaDoc.

La etiqueta @deprecated JavaDoc se utiliza con fines documentales.

La anotación @Deprecated indica al compilador que el método está en desuso. Aquí es lo que dice en el documento Sun/oráculos sobre el tema:

Utilizando la anotación @Deprecated despreciar a una clase, método o campo asegura que todos los compiladores emitirán advertencias cuando el código utiliza ese elemento del programa. Por el contrario, no hay ninguna garantía de que todos los compiladores emitan siempre advertencias basadas en la etiqueta Javadoc, aunque actualmente los compiladores de Sun lo hacen. Otros compiladores no pueden emitir tales advertencias.Por lo tanto, usar la anotación @Deprecated para generar advertencias es más portátil que confiar en la etiqueta @deprecated Javadoc.

Puede encontrar el documento completo en How and When to Deprecate APIs

Answer 6

ya que algunas explicaciones menores faltaban

Uso @Deprecated anotación en el método como este

/** 
* @param baseprice 
* 
* @deprecated reason this method is deprecated </br> 
*    {will be removed in next version} </br> 
*    use {@link #setPurchasePrice()} instead like this: 
* 
* <blockquote> 
* <pre> 
* getProduct().setPurchasePrice(200) 
* </pre></blockquote> 
* 
*/ 
@Deprecated 
public void setBaseprice(int baseprice) { 
} 

recordar a explicar:

• ¿Por qué es este método ya no se recomienda, remeber a la línea separada para facilitar la lectura </br>
• Cuando será eliminado (que los usuarios sepan lo mucho que todavía puede confiar en este método si decidieron adherirse a la manera antigua)
• Proporcionar una solución o vínculo con el método que recomienda {@link #setPurchasePrice()}