source: ether_core/trunk/kit/interactifKit/zipContent/src/Singleton.java @ 784

/**
 *      <p>Cette classe implémente le Singleton pattern exposé par
 *      Gamma et al. dans leur livre désormais célèbre.</p>
 *      <p>Elle permet d'instancier des singletons nommés et de gérer
 *      tous les singletons d'une application.</p>
 *
 * @since JDK 1.2
 * @version $Id: Singleton.java,v 1.1 2001/01/15 15:38:47 pn Exp $
 * @author Phillip Link
 */
package fr.alcatel.ether.tools.singleton;

// JDK
import java.util.HashMap;
import java.util.Set;
import java.util.Iterator;

public class Singleton {
        /** Gestion de la mise au point */
        protected static boolean _DEBUG = false;
        
        /** L'instance du singleton */
        private static Singleton _uniqueInstance = null;

        /** Collection de singletons nommés */
        private static HashMap registry = new HashMap( );
        
        /**
         *      <p>Construire l'unique instance de ce Singleton.</p>
         *      <p>Accéder à l'instance du singleton par la méthode <code>instance</code>.</p>
         *      <p>Cette méthode doit être implémentée par une classe dérivée.</p>
         *      <p>Le constructeur est <code>protected</code>, ce qui permet aux autres classes
         *      du paquetage d'y accéder. Afin d'assurer que seules les classes dérivées
         *      y accèdent, cette classe doit être la seule du paquetage.</p>
         *
         *      @see instance
         */
        protected Singleton( ) {
        }
        
        /**
         *      <p>Obtenir une instance de singleton.</p>
         *      <p>Cette méthode doit être implémentée par une classe dérivée.</p>
         *
         *      @return l'instance de l'objet voulu
         */
        public static Singleton instance( ) {
                if ( _uniqueInstance == null ) {
                        _uniqueInstance = new Singleton( );
                }
                return _uniqueInstance;
        }

        /**
         *      <p>Obtenir une instance du singleton nommé.</p>
         *
         *      @param  le nom de l'objet voulu
         *      @return l'instance de l'objet voulu
         */
        public static Singleton instance( String name ) {
                return (Singleton)registry.get( name );
        }

        /**
         *      <p>Obtenir une instance de singleton.</p>
         *      <p>Cette méthode doit être appelée par une classe dérivée
         *      lors de la construction, par exemple:</p>
         *      <code>
         *      <p>MySingleton( ) {</p>
         *      <p>    Singleton.register( this.getClass().toString(), this );</p>
         *      <p>}</p>
         *      </code>
         *
         *      <p>N'oubliez pas de déclarer et initialiser une variable correspondant
         *      au singleton:</p>
         *      <code>
         *      <p>public class MySingleton {</p>
         *      <p>    private static MySingleton singleton = new MySingleton( );</p>
         *      <p>    // autre code ..../p>
         *      <p>}</p>
         *      </code>
         *
         *      @return l'instance de l'objet voulu
         */
        public static void register( String name, Singleton singleton ) {
                registry.put( name, singleton );
                // Debugging
                if ( _DEBUG ) {
                        System.out.println( "Registering a new singleton" );
                        System.out.println( "Current registry contains:" );
                        Set singletons = registry.keySet( );
                        for ( Iterator s = singletons.iterator(); s.hasNext(); ) {
                                System.out.println( "- " + s.next() );
                        }
                }
        }
}