Source for java.util.MissingFormatWidthException

   1: /* MissingFormatWidthException.java
   2:    Copyright (C) 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.util;
  40: 
  41: /**
  42:  * Thrown when the a format specification for a {@link Formatter}
  43:  * does not include a width for a value where one is required.
  44:  *
  45:  * @author Tom Tromey (tromey@redhat.com)
  46:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  47:  * @since 1.5
  48:  */
  49: public class MissingFormatWidthException
  50:   extends IllegalFormatException
  51: {
  52:   private static final long serialVersionUID = 15560123L;
  53: 
  54:   /**
  55:    * The format specification which contains the
  56:    * unmatched argument.
  57:    *
  58:    * @serial the format specification.
  59:    */
  60:   // Note: name fixed by serialization.
  61:   private String s;
  62: 
  63:   /**
  64:    * Constructs a new <code>MissingFormatWidthException</code>
  65:    * for a format specification, <code>s</code>, which excludes
  66:    * a required width argument.
  67:    *
  68:    * @param s the format specification.
  69:    * @throws NullPointerException if <code>s</code> is null.
  70:    */
  71:   public MissingFormatWidthException(String s)
  72:   {
  73:     super("The specification, " + s + ", misses a required width.");
  74:     if (s == null)
  75:       throw new NullPointerException("The specification is null.");
  76:     this.s = s;
  77:   }
  78: 
  79:   /**
  80:    * Returns the format specification.
  81:    *
  82:    * @return the format specification.
  83:    */
  84:   public String getFormatSpecifier()
  85:   {
  86:     return s;
  87:   }
  88: }