Source for gnu.javax.print.ipp.attribute.printer.DocumentFormat

   1: /* DocumentFormat.java --
   2:    Copyright (C) 2006 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 gnu.javax.print.ipp.attribute.printer;
  40: 
  41: import java.util.Locale;
  42: 
  43: import javax.print.DocFlavor;
  44: import javax.print.attribute.Attribute;
  45: import javax.print.attribute.SupportedValuesAttribute;
  46: import javax.print.attribute.TextSyntax;
  47: 
  48: /**
  49:  * <code>DocumentFormatSupported</code> specifies the supported document
  50:  * formats of a printer. Printer are supplying a set of this attribute.
  51:  *
  52:  * @author Wolfgang Baer (WBaer@gmx.de)
  53:  */
  54: public final class DocumentFormat extends TextSyntax
  55:   implements SupportedValuesAttribute
  56: {
  57: 
  58:   /**
  59:    * Creates a <code>DocumentFormat</code> object with the
  60:    * given value and locale.
  61:    *
  62:    * @param value the value for this syntax
  63:    * @param locale the locale to use, if <code>null</code> the default
  64:    * locale is used.
  65:    *
  66:    * @exception NullPointerException if value is null
  67:    */
  68:   public DocumentFormat(String value, Locale locale)
  69:   {
  70:     super(value, locale);
  71:   }
  72: 
  73:   /**
  74:    * Constructs a document format object for the given flavor.
  75:    * The constructor reworkes the mimetype of the given flavor
  76:    * to remove the quoted charset parameter if present.
  77:    *
  78:    * @param flavor the flavor with the mimetype
  79:    * @return The created document format.
  80:    */
  81:   public static DocumentFormat createDocumentFormat(DocFlavor flavor)
  82:   {
  83:     String charset = flavor.getParameter("charset");
  84:     String mimetype = flavor.getMediaType() + "/" + flavor.getMediaSubtype();
  85:     if (charset != null)
  86:       mimetype += "; charset=" + charset;
  87: 
  88:     return new DocumentFormat(mimetype, null);
  89:   }
  90: 
  91:   /**
  92:    * Returns category of this class.
  93:    *
  94:    * @return The class <code>DocumentFormat</code> itself.
  95:    */
  96:   public Class<? extends Attribute> getCategory()
  97:   {
  98:     return DocumentFormat.class;
  99:   }
 100: 
 101:   /**
 102:    * Returns the name of this attribute.
 103:    *
 104:    * @return The name "document-format".
 105:    */
 106:   public String getName()
 107:   {
 108:     return "document-format";
 109:   }
 110: 
 111: }