1: /* GraphicsConfigTemplate.java -- a template for selecting configurations 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., 51 Franklin Street, Fifth Floor, Boston, MA 19: 02110-1301 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: import java.io.Serializable; 42: 43: /** 44: * This allows filtering an array of GraphicsConfigurations for the best 45: * one based on various requirements. The resulting configuration has had 46: * all non-default attributes set as required to meet or exceed the request. 47: * 48: * @author Eric Blake (ebb9@email.byu.edu) 49: * @see GraphicsConfiguration 50: * @see GraphicsDevice 51: * @since 1.2 52: * @status updated to 1.4 53: */ 54: public abstract class GraphicsConfigTemplate implements Serializable 55: { 56: /** 57: * Compatible with JDK 1.2+. 58: */ 59: private static final long serialVersionUID = -8061369279557787079L; 60: 61: /** States that a feature is required to select a configuration. */ 62: public static final int REQUIRED = 1; 63: 64: /** 65: * States that a feature is preferred, but not required, to select a 66: * configuration. In the case of multiple valid configurations, the tie 67: * breaks in favor of the one with the feature. 68: */ 69: public static final int PREFERRED = 2; 70: 71: /** 72: * States that a feature is not necessary in the configuration. In the case 73: * of multiple valid configurations, the tie breaks in favor of the one 74: * without the feature, to reduce overhead. 75: */ 76: public static final int UNNECESSARY = 3; 77: 78: /** 79: * The default constructor. 80: */ 81: public GraphicsConfigTemplate() 82: { 83: } 84: 85: /** 86: * Returns the "best" match among the array of possible configurations, given 87: * the criteria of this template. 88: * 89: * @param array the array to choose from 90: * @return the best match 91: * @throws NullPointerException if array is null 92: */ 93: public abstract GraphicsConfiguration getBestConfiguration 94: (GraphicsConfiguration[] array); 95: 96: /** 97: * Returns true if the given configuration supports all the features required 98: * by this template. 99: * 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