libjava/java/awt/BufferCapabilities.java

   1 /* BufferCapabilities.java --
   2    Copyright (C) 2002, 2005  Free Software Foundation, Inc.
   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;
  40
  41 /**
  42  * Needs documentation...
  43  *
  44  * @author Eric Blake (ebb9@email.byu.edu)
  45  * @see BufferStrategy#getCapabilities()
  46  * @see GraphicsConfiguration#getCapabilities()
  47  * @since 1.4
  48  * @status updated to 1.4, lacks documentation
  49  */
  50 public class BufferCapabilities implements Cloneable
  51 {
  52   public static final class FlipContents extends AttributeValue
  53   {
  54     private static final String[] NAMES
  55       = { "undefined", "background", "prior", "copied" };
  56     public static final FlipContents UNDEFINED = new FlipContents(0);
  57     public static final FlipContents BACKGROUND = new FlipContents(1);
  58     public static final FlipContents PRIOR = new FlipContents(2);
  59     public static final FlipContents COPIED = new FlipContents(3);
  60     private FlipContents(int value)
  61     {
  62       super(value, NAMES);
  63     }
  64   } // class FlipContents
  65
  66   private final ImageCapabilities front;
  67   private final ImageCapabilities back;
  68   private final FlipContents flip;
  69
  70   /**
  71    * Creates a buffer capabilities object.
  72    *
  73    * @exception IllegalArgumentException If frontCaps or backCaps are null.
  74    */
  75   public BufferCapabilities(ImageCapabilities front, ImageCapabilities back,
  76                             FlipContents flip)
  77   {
  78     this.front = front;
  79     this.back = back;
  80     this.flip = flip;
  81     if (front ==  null || back == null)
  82       throw new IllegalArgumentException();
  83   }
  84
  85   public ImageCapabilities getFrontBufferCapabilities()
  86   {
  87     return front;
  88   }
  89
  90   public ImageCapabilities getBackBufferCapabilities()
  91   {
  92     return back;
  93   }
  94
  95   public boolean isPageFlipping()
  96   {
  97     return flip != null;
  98   }
  99
 100   public FlipContents getFlipContents()
 101   {
 102     return flip;
 103   }
 104
 105   public boolean isFullScreenRequired()
 106   {
 107     return true;
 108   }
 109
 110   public boolean isMultiBufferAvailable()
 111   {
 112     return false;
 113   }
 114
 115   public Object clone()
 116   {
 117     try
 118       {
 119         return super.clone();
 120       }
 121     catch (CloneNotSupportedException e)
 122       {
 123         throw (Error) new InternalError().initCause(e); // Impossible
 124       }
 125   }
 126 } // class BufferCapabilities