001/* GraphicsConfigTemplate.java -- a template for selecting configurations
002   Copyright (C) 2002, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt;
040
041import java.io.Serializable;
042
043/**
044 * This allows filtering an array of GraphicsConfigurations for the best
045 * one based on various requirements. The resulting configuration has had
046 * all non-default attributes set as required to meet or exceed the request.
047 *
048 * @author Eric Blake (ebb9@email.byu.edu)
049 * @see GraphicsConfiguration
050 * @see GraphicsDevice
051 * @since 1.2
052 * @status updated to 1.4
053 */
054public abstract class GraphicsConfigTemplate implements Serializable
055{
056  /**
057   * Compatible with JDK 1.2+.
058   */
059  private static final long serialVersionUID = -8061369279557787079L;
060
061  /** States that a feature is required to select a configuration. */
062  public static final int REQUIRED = 1;
063
064  /**
065   * States that a feature is preferred, but not required, to select a
066   * configuration. In the case of multiple valid configurations, the tie
067   * breaks in favor of the one with the feature.
068   */
069  public static final int PREFERRED = 2;
070
071  /**
072   * States that a feature is not necessary in the configuration. In the case
073   * of multiple valid configurations, the tie breaks in favor of the one
074   * without the feature, to reduce overhead.
075   */
076  public static final int UNNECESSARY = 3;
077
078  /**
079   * The default constructor.
080   */
081  public GraphicsConfigTemplate()
082  {
083  }
084
085  /**
086   * Returns the "best" match among the array of possible configurations, given
087   * the criteria of this template.
088   *
089   * @param array the array to choose from
090   * @return the best match
091   * @throws NullPointerException if array is null
092   */
093  public abstract GraphicsConfiguration getBestConfiguration
094    (GraphicsConfiguration[] array);
095
096  /**
097   * Returns true if the given configuration supports all the features required
098   * by this template.
099   *
100   * @param config the configuration to test
101   * @return true if it is a match
102   * @throws NullPointerException if config is null
103   */
104  public abstract boolean isGraphicsConfigSupported
105    (GraphicsConfiguration config);
106} // class GraphicsConfigTemplate