Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4444202

Spec: ImageReader - typos in descriptions of some methods

XMLWordPrintable

    • beta2
    • generic
    • generic



      Name: bkR10012 Date: 04/13/2001



      Spec. of the class javax.imageio.ImageReader contains some typos:

      - description of setLocale(Locale locale) uses words 'ImageWriter' and
        'writer' instead of 'ImageReader', 'reader':

      "public void setLocale(Locale locale)

          Sets the current Locale of this ImageWriter to the given value.
          A value of null removes any previous setting, and indicates
          that the writer should localize as it sees fit."
           
      - description of getDefaultReadParam() says about non-existent
        constructor ImageReadParam(boolean) instead of ImageReadParam():

      " The default implementation constructs and returns a new
           ImageReadParam object that does not allow source scaling
           (i.e., it returns new ImageReadParam(false)."
           
      - description of readerSupportsThumbnails() is cut at "Returns:" section:

      "public boolean readerSupportsThumbnails()

           Returns true if the image format understood by this reader
           supports thumbnail preview images associated with it.
           The default implementation returns false.
      ....
           Returns:
               true"

      - description of readThumbnail uses word 'IndexOutOfBoundsException'
        instead of 'UnsupportedOperationException':
       
      "If the reader does not support thumbnails, (readerSupportsThumbnails
       returns false), an IndexOutOfBoundsException will be thrown regardless
       of whether an input source has been set or whether the indices are in
       bounds.
       
       The default implementation throws an UnsupportedOperationException."

      ======================================================================

            dricesunw Daniel Rice (Inactive)
            kuzsunw Kuz Kuz (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: