libjava/java/awt/geom/Dimension2D.java

   1 /* Dimension2D.java -- abstraction of a dimension
   2    Copyright (C) 1999, 2000, 2002 Free Software Foundation
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.awt.geom;
  40
  41 /**
  42  * This stores a dimension in 2-dimensional space - a width (along the x-axis)
  43  * and height (along the y-axis). The storage is left to subclasses.
  44  *
  45  * @author Per Bothner <bothner@cygnus.com>
  46  * @author Eric Blake <ebb9@email.byu.edu>
  47  * @since 1.2
  48  * @status updated to 1.4
  49  */
  50 public abstract class Dimension2D implements Cloneable
  51 {
  52   /**
  53    * The default constructor.
  54    */
  55   protected Dimension2D()
  56   {
  57   }
  58
  59   /**
  60    * Get the width of this dimension. A negative result, while legal, is
  61    * undefined in meaning.
  62    *
  63    * @return the width
  64    */
  65   public abstract double getWidth();
  66
  67   /**
  68    * Get the height of this dimension. A negative result, while legal, is
  69    * undefined in meaning.
  70    *
  71    * @return the height
  72    */
  73   public abstract double getHeight();
  74
  75   /**
  76    * Set the size of this dimension to the requested values. Loss of precision
  77    * may occur.
  78    *
  79    * @param w the new width
  80    * @param h the new height
  81    */
  82   public abstract void setSize(double w, double h);
  83
  84   /**
  85    * Set the size of this dimension to the requested value. Loss of precision
  86    * may occur.
  87    *
  88    * @param d the dimension containing the new values
  89    *
  90    * @throws NullPointerException if d is null
  91    */
  92   public void setSize(Dimension2D d)
  93   {
  94     setSize(d.getWidth(), d.getHeight());
  95   }
  96
  97   /**
  98    * Create a new dimension of the same run-time type with the same contents
  99    * as this one.
 100    *
 101    * @return the clone
 102    *
 103    * @exception OutOfMemoryError If there is not enough memory available.
 104    *
 105    * @since 1.2
 106    */
 107   public Object clone()
 108   {
 109     try
 110       {
 111         return super.clone();
 112       }
 113     catch (CloneNotSupportedException e)
 114       {
 115         throw (Error) new InternalError().initCause(e); // Impossible
 116       }
 117   }
 118 } // class Dimension2D