Save This Page
Home » openjdk-7 » javax » print » attribute » [javadoc | source]
    1   /*
    2    * Copyright 2000-2004 Sun Microsystems, Inc.  All Rights Reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Sun designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Sun in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
   22    * CA 95054 USA or visit www.sun.com if you need additional information or
   23    * have any questions.
   24    */
   25   
   26   package javax.print.attribute;
   27   
   28   import java.io.Serializable;
   29   
   30   /**
   31    * Interface Attribute is the base interface implemented by any and every
   32    * printing attribute class to indicate that the class represents a
   33    * printing attribute. All printing attributes are serializable.
   34    * <P>
   35    *
   36    * @author  David Mendenhall
   37    * @author  Alan Kaminsky
   38    */
   39   public interface Attribute extends Serializable {
   40   
   41     /**
   42      * Get the printing attribute class which is to be used as the "category"
   43      * for this printing attribute value when it is added to an attribute set.
   44      *
   45      * @return  Printing attribute class (category), an instance of class
   46      *          {@link java.lang.Class java.lang.Class}.
   47      */
   48     public Class<? extends Attribute> getCategory();
   49   
   50     /**
   51      * Get the name of the category of which this attribute value is an
   52      * instance.
   53      * <P>
   54      * <I>Note:</I> This method is intended to provide a default, nonlocalized
   55      * string for the attribute's category. If two attribute objects return the
   56      * same category from the <CODE>getCategory()</CODE> method, they should
   57      * return the same name from the <CODE>getName()</CODE> method.
   58      *
   59      * @return  Attribute category name.
   60      */
   61     public String getName();
   62   
   63   }

Save This Page
Home » openjdk-7 » javax » print » attribute » [javadoc | source]