Package com.atlassian.jira.lookandfeel.image

Class ImageDescriptorFactoryImpl

java.lang.Object

com.atlassian.jira.lookandfeel.image.ImageDescriptorFactoryImpl

All Implemented Interfaces:

ImageDescriptorFactory

@Component
public class ImageDescriptorFactoryImpl
extends Object
implements ImageDescriptorFactory

Used to construct ImageDescriptor objects. Constructed objects need to be closed

Since:

v7.1

See Also:

• ImageDescriptor.closeImageStreamQuietly()

Constructor Summary

Constructors

Constructor	Description
ImageDescriptorFactoryImpl(I18nHelper i18nHelper, com.atlassian.sal.api.net.RequestFactory<com.atlassian.sal.api.net.Request<?,com.atlassian.sal.api.net.Response>> requestFactory)

Method Summary

Modifier and Type	Method	Description
boolean	isUrlSupported(String url)	Checks if url can be used to construct ImageDescriptor using withUrl(String)
ImageDescriptor	withRequest(String parameterName, webwork.multipart.MultiPartRequestWrapper multiPartRequest)
ImageDescriptor	withUrl(String url)	If provided url is supported it constructs ImageDescriptor object with it

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ImageDescriptorFactoryImpl

public ImageDescriptorFactoryImpl(I18nHelper i18nHelper,
 com.atlassian.sal.api.net.RequestFactory<com.atlassian.sal.api.net.Request<?,com.atlassian.sal.api.net.Response>> requestFactory)

Method Details

isUrlSupported

public boolean isUrlSupported(String url)

Checks if url can be used to construct ImageDescriptor using withUrl(String)

Specified by:

isUrlSupported in interface ImageDescriptorFactory

Parameters:

url - - url to check

Returns:

true if url can be used; false if url should not be used (will cause Exception)

withUrl

public ImageDescriptor withUrl(String url)
                        throws IOException

If provided url is supported it constructs ImageDescriptor object with it

Specified by:

withUrl in interface ImageDescriptorFactory

Parameters:

url - - url to create ImageDescriptor with

Returns:

ImageDescriptor object containing image data that was pointed by provided url

Throws:

IOException - - when fails to open stream to image resource provided by url. Can occur with:

IllegalArgumentException - - if url is not supported

See Also:

• invalid reference

  URL#openConnection()

• invalid reference

  URLConnection#connect()

• invalid reference

  URLConnection#getInputStream()

• URLImageDescriptor.isUrlSupported(String)

withRequest

public ImageDescriptor withRequest(String parameterName,
 webwork.multipart.MultiPartRequestWrapper multiPartRequest)
                            throws IOException

Specified by:

withRequest in interface ImageDescriptorFactory

Parameters:

parameterName - - parameter name for uploaded image contained in provided MultiPartRequestWrapper

multiPartRequest - - multi part request containing image

Returns:

ImageDescriptor object containing image data uploaded by request

Throws:

IOException - - with constructor for FileInputStream(String)