BufferCapabilities.java   [plain text]

/* BufferCapabilities.java -- 
   Copyright (C) 2002, 2005  Free Software Foundation, Inc.

This file is part of GNU Classpath.

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

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

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.awt;

/**
 * Needs documentation...
 *
 * @author Eric Blake (ebb9@email.byu.edu)
 * @see BufferStrategy#getCapabilities()
 * @see GraphicsConfiguration#getCapabilities()
 * @since 1.4
 * @status updated to 1.4, lacks documentation
 */
public class BufferCapabilities implements Cloneable
{
  public static final class FlipContents extends AttributeValue
  {
    private static final String[] NAMES
      = { "undefined", "background", "prior", "copied" };
    public static final FlipContents UNDEFINED = new FlipContents(0);
    public static final FlipContents BACKGROUND = new FlipContents(1);
    public static final FlipContents PRIOR = new FlipContents(2);
    public static final FlipContents COPIED = new FlipContents(3);
    private FlipContents(int value)
    {
      super(value, NAMES);
    }
  } // class FlipContents

  private final ImageCapabilities front;
  private final ImageCapabilities back;
  private final FlipContents flip;

  /**
   * Creates a buffer capabilities object.
   *
   * @exception IllegalArgumentException If frontCaps or backCaps are null.
   */
  public BufferCapabilities(ImageCapabilities front, ImageCapabilities back,
                            FlipContents flip)
  {
    this.front = front;
    this.back = back;
    this.flip = flip;
    if (front ==  null || back == null)
      throw new IllegalArgumentException();
  }

  public ImageCapabilities getFrontBufferCapabilities()
  {
    return front;
  }

  public ImageCapabilities getBackBufferCapabilities()
  {
    return back;
  }

  public boolean isPageFlipping()
  {
    return flip != null;
  }

  public FlipContents getFlipContents()
  {
    return flip;
  }

  public boolean isFullScreenRequired()
  {
    return true;
  }

  public boolean isMultiBufferAvailable()
  {
    return false;
  }

  public Object clone()
  {
    try
      {
        return super.clone();
      }
    catch (CloneNotSupportedException e)
      {
        throw (Error) new InternalError().initCause(e); // Impossible
      }
  }
} // class BufferCapabilities