/* Insets.java -- Information about a container border.
   Copyright (C) 1999 Free Software Foundation, Inc.

This file is part of the non-peer AWT libraries of GNU Classpath.

This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Library General Public License as published 
by the Free Software Foundation, either version 2 of the License, or
(at your option) any later verion.

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 Library General Public License for more details.

You should have received a copy of the GNU Library General Public License
along with this library; if not, write to the Free Software Foundation
Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA. */


package java.awt;

/**
  * This class represents the "margin" or space around a container.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public class Insets implements Cloneable, java.io.Serializable
{

/*
 * Instance Variable
 */

/**
  * @serial The top inset
  */
public int top;

/**
  * @serial This bottom inset
  */
public int bottom;

/**
  * @serial The left inset
  */
public int left;

/**
  * @serial The right inset
  */
public int right;

/*************************************************************************/

/**
  * Initializes a new instance of <code>Inset</code> with the specified
  * inset values.
  *
  * @param top The top inset
  * @param left The left inset
  * @param bottom The bottom inset
  * @param right The right inset
  */
public
Insets(int top, int left, int bottom, int right)
{
  this.top = top;
  this.left = left;
  this.bottom = bottom;
  this.right = right;
}

/*************************************************************************/

/*
 * Instance Methods
 */

/**
  * Tests whether this object is equal to the specified object.  This will
  * be true if and only if the specified object:
  * <p>
  * <ul>
  * <li>Is not <code>null</code>.
  * <li>Is an instance of <code>Insets</code>.
  * <li>Has the same top, bottom, left, and right inset values as this object.
  * </ul>
  *
  * @param obj The object to test against.
  *
  * @return <code>true</code> if the specified object is equal to this
  * one, <code>false</code> otherwise.
  */
public boolean
equals(Object obj)
{
  if (obj == null)
    return(false);

  if (!(obj instanceof Insets))
    return(false);

  Insets i = (Insets)obj;

  if (i.top != top)
    return(false);
  if (i.bottom != bottom)
    return(false);
  if (i.left != left)
    return(false);
  if (i.right != right)
    return(false);

  return(true);
}

/*************************************************************************/

/**
  * Returns a string representation of this object.
  *
  * @return A string representation of this object.
  */
public String
toString()
{
  return(getClass().getName() + "(top=" + top + ",bottom=" + bottom +
         ",left=" + left + ",right=" + right + ")");
}

/*************************************************************************/

/**
  * Returns a copy of this object.
  *
  * @return A copy of this object.
  */
public Object
clone()
{
  try
    {
      return(super.clone());
    }
  catch(Exception e)
    {
      return(null);
    }
}

} // class Insets