Home | History | Annotate | Download | only in util
      1 /*
      2  * Copyright (c) 2003, Oracle and/or its affiliates. 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.  Oracle designates this
      8  * particular file as subject to the "Classpath" exception as provided
      9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
     22  * or visit www.oracle.com if you need additional information or have any
     23  * questions.
     24  */
     25 
     26 package java.util;
     27 
     28 /**
     29  * Unchecked exception thrown when an unknown flag is given.
     30  *
     31  * <p> Unless otherwise specified, passing a <tt>null</tt> argument to any
     32  * method or constructor in this class will cause a {@link
     33  * NullPointerException} to be thrown.
     34  *
     35  * @since 1.5
     36  */
     37 public class UnknownFormatFlagsException extends IllegalFormatException {
     38 
     39     private static final long serialVersionUID = 19370506L;
     40 
     41     private String flags;
     42 
     43     /**
     44      * Constructs an instance of this class with the specified flags.
     45      *
     46      * @param  f
     47      *         The set of format flags which contain an unknown flag
     48      */
     49     public UnknownFormatFlagsException(String f) {
     50         if (f == null)
     51             throw new NullPointerException();
     52         this.flags = f;
     53     }
     54 
     55     /**
     56      * Returns the set of flags which contains an unknown flag.
     57      *
     58      * @return  The flags
     59      */
     60     public String getFlags() {
     61         return flags;
     62     }
     63 
     64     // javadoc inherited from Throwable.java
     65     public String getMessage() {
     66         return "Flags = " + flags;
     67     }
     68 }
     69