/* EMBLObject.java
 *
 * created: Tue Nov 17 1998
 *
 * This file is part of Artemis
 * 
 * Copyright (C) 1998,1999,2000  Genome Research Limited
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * $Header: /cvsroot/pathsoft/artemis/uk/ac/sanger/artemis/io/EMBLObject.java,v 1.1 2004/06/09 09:49:08 tjc Exp $
 **/

package uk.ac.sanger.artemis.io;

/**
 *  This class is the base class for objects in the embl package.
 *
 *  @author Kim Rutherford
 *  @version $Id: EMBLObject.java,v 1.1 2004/06/09 09:49:08 tjc Exp $
 **/

class EMBLObject 
{

  /**
   *  An arbitrary data reference, set with a call to setUserData ().
   **/
  private Object user_data;

  /**
   *  Create a new EMBLObject object.
   **/
  public EMBLObject() 
  {

  }

  /**
   *  Set the user data reference for this object.  The user data object is
   *  chosen by the user of this class.  This facility is provided to make it
   *  easier to wrap this class in more powerful classes.
   *  @param user_data The new value of the user data reference of this object.
   *    The existing user data reference (if any) is lost.
   **/
  public void setUserData(Object user_data) 
  {
    this.user_data = user_data;
  }

  /**
   *  Return the user data reference for this object, as set by a call to
   *  setUserData().
   **/
  public Object getUserData() 
  {
    return user_data;
  }
  
}
