Docmosis API 4.5.0

com.docmosis.template.population
Class ImageSupplierInfo

java.lang.Object
  extended bycom.docmosis.template.population.ImageSupplierInfo

public class ImageSupplierInfo
extends Object

Information about the supply of an image.

See Also:
ImageSupplier, RenderRequest

Constructor Summary
ImageSupplierInfo(boolean imageSupplied, InputStream imageStream)
          Create a new set of details about the image supplied
 
Method Summary
 InputStream getImageStream()
          Get the input stream of the image.
 boolean isImageSupplied()
          Determine if the image is supplied.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageSupplierInfo

public ImageSupplierInfo(boolean imageSupplied,
                         InputStream imageStream)
Create a new set of details about the image supplied

Parameters:
imageSupplied - if false, other suppliers can be asked to supply the image
imageStream - the stream for the image (may be null)
Method Detail

isImageSupplied

public boolean isImageSupplied()
Determine if the image is supplied. If this method returns true, no further suppliers in a possible chain of suppliers will be asked to supply the image. This allows getImageStream() to return null intentionally as the correct (though blank) image.

Returns:
true if this represents a supplied image.

getImageStream

public InputStream getImageStream()
Get the input stream of the image.

Returns:
null if there is no image

Docmosis API 4.5.0

Copyright © 2014 Docmosis Pty Ltd. All Rights Reserved.