001 /* Dimension2D.java -- abstraction of a dimension 002 Copyright (C) 1999, 2000, 2002 Free Software Foundation 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 039 package java.awt.geom; 040 041 /** 042 * This stores a dimension in 2-dimensional space - a width (along the x-axis) 043 * and height (along the y-axis). The storage is left to subclasses. 044 * 045 * @author Per Bothner (bothner@cygnus.com) 046 * @author Eric Blake (ebb9@email.byu.edu) 047 * @since 1.2 048 * @status updated to 1.4 049 */ 050 public abstract class Dimension2D implements Cloneable 051 { 052 /** 053 * The default constructor. 054 */ 055 protected Dimension2D() 056 { 057 } 058 059 /** 060 * Get the width of this dimension. A negative result, while legal, is 061 * undefined in meaning. 062 * 063 * @return the width 064 */ 065 public abstract double getWidth(); 066 067 /** 068 * Get the height of this dimension. A negative result, while legal, is 069 * undefined in meaning. 070 * 071 * @return the height 072 */ 073 public abstract double getHeight(); 074 075 /** 076 * Set the size of this dimension to the requested values. Loss of precision 077 * may occur. 078 * 079 * @param w the new width 080 * @param h the new height 081 */ 082 public abstract void setSize(double w, double h); 083 084 /** 085 * Set the size of this dimension to the requested value. Loss of precision 086 * may occur. 087 * 088 * @param d the dimension containing the new values 089 * 090 * @throws NullPointerException if d is null 091 */ 092 public void setSize(Dimension2D d) 093 { 094 setSize(d.getWidth(), d.getHeight()); 095 } 096 097 /** 098 * Create a new dimension of the same run-time type with the same contents 099 * 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