001/* DocAttributeSet.java -- 002 Copyright (C) 2003, 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 038package javax.print.attribute; 039 040/** 041 * <code>DocAttributeSet</code> specifies an attribute set which only 042 * allows printing attributes of type 043 * {@link javax.print.attribute.DocAttribute}. 044 * <p> 045 * The methods {@link #add(Attribute)} and {@link #addAll(AttributeSet)} are 046 * respecified in this interface to indicate that only 047 * <code>DocAttribute</code> instances are allowed in this set. 048 * </p> 049 * 050 * @author Michael Koch (konqueror@gmx.de) 051 */ 052public interface DocAttributeSet extends AttributeSet 053{ 054 /** 055 * Adds the specified attribute value to this attribute set 056 * if it is not already present. 057 * 058 * This operation removes any existing attribute of the same category 059 * before adding the given attribute. 060 * 061 * @param attribute the attribute to add. 062 * @return <code>true</code> if the set is changed, false otherwise. 063 * @throws ClassCastException if attribute is not of type 064 * <code>DocAttribute</code>. 065 * @throws NullPointerException if the attribute is <code>null</code>. 066 * @throws UnmodifiableSetException if the set does not support modification. 067 */ 068 boolean add (Attribute attribute); 069 070 /** 071 * Adds all of the elements in the specified set to this attribute set. 072 * 073 * @param attributes the set of attributes to add. 074 * @return <code>true</code> if the set is changed, false otherwise. 075 * @throws ClassCastException if one of the attributes is not of type 076 * <code>DocAttribute</code>. 077 * @throws UnmodifiableSetException if the set does not support modification. 078 * 079 * @see #add(Attribute) 080 */ 081 boolean addAll (AttributeSet attributes); 082}