Logo
Distributed Genetic Programming Framework
print print

File org.sfc.id.ID.java

Here you can find all the information about the file org.sfc.id.ID.java. You may explore it here or download it onto your local disk.
/*
 * Copyright (c) 2006 Thomas Weise
 * 
 * E-Mail           : tweise@gmx.de
 * Creation Date    : 2006-05-24 15:11:06
 * Original Filename: org.sfc.id.ID.java
 * Version          : 1.0.1
 * Last modification: 2006-05-28
 *                by: Thomas Weise
 * 
 * License          : GNU LESSER GENERAL PUBLIC LICENSE
 *                    Version 2.1, February 1999
 *                    You should have received a copy of this license along
 *                    with this library; if not, write to the Free Software
 *                    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *                    MA 02111-1307, USA or download the license under
 *                    http://www.gnu.org/copyleft/lesser.html.
 *                    
 * Warranty         : This software is provided "as is" without any
 *                    warranty; without even the implied warranty of
 *                    merchantability or fitness for a particular purpose.
 *                    See the Gnu Lesser General Public License for more
 *                    details.
 */

 
package org.sfc.id;

import java.io.Serializable;

import org.sfc.text.Text;
import org.sfc.utils.ICloneable;
import org.sfc.utils.Typesafe;

/**
 * This class represents unique identifiers.
 * @param <Type>    The type of the objects this sort of id will uniquely
 *                  be assigned to - classes or strings are common.
 * @param <IDType>  The type of this class.
 * @author Thomas Weise
 */

public abstract class ID<Type, IDType extends    ID<Type, IDType>>
                                      implements ICloneable, Serializable
  {
/**
 * The serial version uid.
 */

  private static final long serialVersionUID = 1;
  
/**
 * The internal identifier object.
 */

  final  Type        m_id  ;
  
  
/**
 * This constructor is suitable for all sorts of normal ids.
 * @param p_id  The external object this id is uniquely assigned to.
 */

  protected ID(final Type p_id)
    {
    this(p_id, true);
    }
  
/**
 * This constructor is suitable for all sorts of normal ids.
 * @param p_id        The external object this id is uniquely assigned to.
 * @param p_immediate <code>true</code> if immediate registration is
 *                    needed.
 */

  ID(final Type    p_id,
     final boolean p_immediate)
    {
    super();
        
    this.m_id = preprocess(p_id);
    if(p_immediate) this.get_manager().add_id(this);
    }
  
/**
 * This constructor is suitable for all sorts of ids that are somehow
 * hierarchical depending 
 * @param p_id      The external object this id is uniquely assigned to.
 * @param p_manager The id manager to use.
 */

  protected ID(final Type                    p_id,
               final IDManager<Type, IDType> p_manager)
    {
    super();
        
    this.m_id = preprocess(p_id);
    p_manager.add_id(this);
    }
  
/**
 * Preprocess the internal identifier.
 * @param p_id  The id to be preprocessed.
 * @param <Type>  The type parameter.
 * @return  The preprocessed id.
 */

  private static  final <Type> Type preprocess (Type p_id)
    {
    if(p_id instanceof String)
      {
      p_id = Typesafe.cast(Text.preprocess((String)p_id));
      }
    return p_id;
    }
  
/**
 * Obtain the internal identifier object.
 * @return The internal identifier object.
 */

  protected final Type  get_id()
    {
    return this.m_id;
    }

/**
 * A clone of an id is always the id itself. This prohibts all sub-classes
 * from being copied.
 *
 * @return     This instance.
 *
 * @see java.lang.Cloneable
 */

  @Override
  public  final Object  clone ()
    {
    return this;
    }
  

/**
 * Obtain the manager for the ids of this type.
 * @return  The manager for the ids of this type.
 */

  protected abstract  IDManager<Type, IDType> get_manager ()  ;
  

/**
 * Returns a hash code value for the object. This method is
 * supported for the benefit of hashtables such as those provided by
 * <code>java.util.Hashtable</code>.
 * This method returns always the hash value provided by the super
 * implementation. This prevents you from changing it in a way leading to
 * ambiguous values. In other words, the values of the members of an
 * instance of <code>ID</code> will never influence the value of its
 * hash code.
 *
 * @return  The hash code of this object.
 */

  @Override
  public  final int hashCode  ()
    {
    return ((this.m_id != null) ? this.m_id.hashCode() : 0);
    }

/**
 * Perform a write replace of this object.
 * @return  The object to store.
 */

  protected final Object writeReplace()
    {
    Object  l_o;
    
    l_o = this.get_manager().resolve(this);
    if(l_o != null) return l_o;
    return this;
    }

/**
 * Deserialize to the proper instance.
 * @return  The globally shared instance.
 */

  protected final Object readResolve()
    {
    return this.writeReplace();
    }


/**
 * Returns a string representation of this object.
 * @return  A string representation of this object.
 */

  @Override
  public  final String  toString  ()
    {
    return this.m_id.toString();
    }
  }

File Information:

file name:ID.java
package:org.sfc.id
qualified name:org.sfc.id.ID.java
file type:Java Source File
download location:download http://dgpf.sourceforge.net/source/org/sfc/id/ID.java
size:5.120 KB (5243 B)
uploaded: 2018-01-07 12:03:36 GMT+0000
last update: 2006-05-28 13:54:36 GMT+0000
last access: 2018-04-25 06:42:50 GMT+0000

statistics online since 2006-01-02.   RSS Feed
Contact us by sending an email to tweise@gmx.de to receive further information, to report errors, or to join our project.
All content on this site (http://dgpf.sourceforge.net/) is LGPL-licensed.
http://dgpf.sourceforge.net/scripts/source/source.php last modified at 2018-01-07 12:03:34 GMT+0000 served at 2018-04-25 06:42:50 GMT+0000.
Valid CSS Valid XHTML 1.1
Valid RSS SourceForge.net Logo