Quel est le moyen le plus clair de déprécier un paquet en Java ?

Question

Je travaille sur une nouvelle base de code et je migre le système vers un nouveau framework.

Il y a un certain nombre de paquets que je voudrais déprécier, juste pour qu'il soit très clair pour les autres développeurs que tout à l'intérieur de ce paquet ne doit plus être utilisé pour un nouveau développement.

Quelle est la meilleure façon d'indiquer qu'un paquet entier a été obsolète ?

Answer 1

J'ai dû le faire récemment et j'ai utilisé le fichier package-info.java pour déprécier le package.

http://www.intertech.com/Blog/whats-package-info-java-for/

Ajoutez un fichier package-info.java à votre package avec uniquement la déclaration du package :

/**
 * @deprecated As of release 2.0, replaced by {@link com.acme.new.package}
 */
@Deprecated
package com.acme.old.package;

Dans Eclipse, tous les endroits où l'utilisateur importe une classe de ce package seront soulignés par un avertissement de dépréciation.

Answer 2

Utiliser AspectJ. Créer un Aspect qui émet un avertissement de compilateur lorsque le paquet est utilisé :

public aspect DeprecationAspect{

    declare warning :
        call(* foo.bar..*(..)) : "Package foo.bar is deprecated";

}

(Vous pouvez facilement ajouter AspectJ à votre build si vous utilisez ant ou maven)

Answer 3

Pour ceux qui sont venus plus tard...
Ma solution avec L'IDÉE "Remplacer en chemin"

Texte à trouver : (public|protected)+(\s)(abstract)(\s)(static)(\s)(final)(\s)*(class|interface|enum|Enum)
Remplacer par : @Deprecated\n\$ 1 \$ 3 \$ 5 \$ 7 \$ 9
Options : (select) Expressions rationnelles
Répertoire : {Choose dir}