Changeset 4792


Ignore:
Timestamp:
02/09/09 09:33:24 (11 years ago)
Author:
melissa
Message:

Updated IFormatWriter Javadocs to make it clear that saveImage methods append an image to a file, rather than overwriting the file.

Location:
trunk/components/bio-formats/src/loci/formats
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/components/bio-formats/src/loci/formats/IFormatWriter.java

    r4359 r4792  
    4040  /** 
    4141   * Saves the given image to the current file. 
     42   * Note that this method will append the image to the file; it will not 
     43   * overwrite previously saved images. 
    4244   * If this image is the last one in the file, the last flag must be set. 
    4345   */ 
     
    4648  /** 
    4749   * Saves the given image to the given series in the current file. 
     50   * Note that this method will append the image to the file; it will not 
     51   * overwrite previously saved images. 
    4852   * If this image is the last one in the series, the lastInSeries flag 
    4953   * must be set. 
     
    5559  /** 
    5660   * Saves the given byte array to the current file. 
     61   * Note that this method will append the byte array to the file; it will not 
     62   * overwrite previously saved byte arrays. 
    5763   * If this is the last array to be written, the last flag must be set. 
    5864   */ 
     
    6268  /** 
    6369   * Saves the given byte array to the given series in the current file. 
     70   * Note that this method will append the byte array to the file; it will not 
     71   * overwrite previously saved byte arrays. 
    6472   * If this is the last array in the series, the lastInSeries flag must be set. 
    6573   * If this is the last array to be written, the last flag must be set. 
  • trunk/components/bio-formats/src/loci/formats/out/OMETiffWriter.java

    r4749 r4792  
    143143  // -- IFormatWriter API methods -- 
    144144 
     145  /* @see loci.formats.IFormatWriter#saveImage(Image, int, boolean, boolean) */ 
    145146  public void saveImage(Image image, int series, boolean lastInSeries, 
    146147    boolean last) throws FormatException, IOException 
Note: See TracChangeset for help on using the changeset viewer.