1 /*
   2  * Copyright (c) 1999, 2013, 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 javax.imageio.event;
  27 
  28 import java.util.EventListener;
  29 import javax.imageio.ImageReader;
  30 
  31 /**
  32  * An interface used by {@code ImageReader} implementations to
  33  * notify callers of their image and thumbnail reading methods of
  34  * warnings (non-fatal errors).  Fatal errors cause the relevant
  35  * read method to throw an {@code IIOException}.
  36  *
  37  * <p> Localization is handled by associating a {@code Locale}
  38  * with each {@code IIOReadWarningListener} as it is registered
  39  * with an {@code ImageReader}.  It is up to the
  40  * {@code ImageReader} to provide localized messages.
  41  *
  42  * @see javax.imageio.ImageReader#addIIOReadWarningListener
  43  * @see javax.imageio.ImageReader#removeIIOReadWarningListener
  44  *
  45  */
  46 public interface IIOReadWarningListener extends EventListener {
  47 
  48     /**
  49      * Reports the occurrence of a non-fatal error in decoding.  Decoding
  50      * will continue following the call to this method.  The application
  51      * may choose to display a dialog, print the warning to the console,
  52      * ignore the warning, or take any other action it chooses.
  53      *
  54      * @param source the {@code ImageReader} object calling this method.
  55      * @param warning a {@code String} containing the warning.
  56      */
  57     void warningOccurred(ImageReader source, String warning);
  58 }