content: /* ========================================================================
   * JCommon : a free general purpose class library for the Java(tm) platform
   * ========================================================================
   *
   * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   * 
   * Project Info:  http://www.jfree.org/jcommon/index.html
   *
   * This library is free software; you can redistribute it and/or modify it 
   * under the terms of the GNU Lesser General Public License as published by 
   * the Free Software Foundation; either version 2.1 of the License, or 
   * (at your option) any later version.
   *
   * This library 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 Lesser General Public 
   * License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
   * USA.  
   *
   * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
   * in the United States and other countries.]
   * 
   * ----------
   * Layer.java
   * ----------
   * (C) Copyright 2003, 2004, by Object Refinery Limited.
   *
   * Original Author:  David Gilbert (for Object Refinery Limited);
   * Contributor(s):   -;
   *
   * $Id: Layer.java,v 1.4 2005/10/18 13:18:34 mungady Exp $
   *
   * Changes:
   * --------
   * 17-Sep-2003 (DG);
   * 
   */
  
  package org.jfree.ui;
  
  import java.io.ObjectStreamException;
  import java.io.Serializable;
  
  /**
   * Used to indicate either the foreground or background layer.
   *
   * @author David Gilbert
   */
  public final class Layer implements Serializable {
  
      /** For serialization. */
      private static final long serialVersionUID = -1470104570733183430L;
      
      /** Foreground. */
      public static final Layer FOREGROUND = new Layer("Layer.FOREGROUND");
  
      /** Background. */
      public static final Layer BACKGROUND = new Layer("Layer.BACKGROUND");
  
      /** The name. */
      private String name;
  
      /**
       * Private constructor.
       *
       * @param name  the name.
       */
      private Layer(final String name) {
          this.name = name;
      }
  
      /**
       * Returns a string representing the object.
       *
       * @return The string.
       */
      public String toString() {
          return this.name;
      }
  
      /**
       * Returns <code>true</code> if this object is equal to the specified 
       * object, and <code>false</code> otherwise.
       *
       * @param o  the other object.
       *
       * @return A boolean.
       */
      public boolean equals(final Object o) {
  
          if (this == o) {
              return true;
          }
          if (!(o instanceof Layer)) {
              return false;
          }
  
          final Layer layer = (Layer) o;
          if (!this.name.equals(layer.name)) {
              return false;
          }
  
          return true;
  
      }
  
      /**
       * Returns a hash code value for the object.
       *
       * @return the hashcode
       */
      public int hashCode() {
          return this.name.hashCode();
      }
  
      /**
       * Ensures that serialization returns the unique instances.
       * 
       * @return The object.
       * 
       * @throws ObjectStreamException if there is a problem.
       */
      private Object readResolve() throws ObjectStreamException {
          Layer result = null;
          if (this.equals(Layer.FOREGROUND)) {
              result = Layer.FOREGROUND;
          }
          else if (this.equals(Layer.BACKGROUND)) {
              result = Layer.BACKGROUND;
          }
          return result;
      }
      
  }
  
  