org.htmlunit.attachment

Class CollectingAttachmentHandler

java.lang.Object

org.htmlunit.attachment.CollectingAttachmentHandler

All Implemented Interfaces:

Serializable, AttachmentHandler

public class CollectingAttachmentHandler
extends Object
implements AttachmentHandler

An AttachmentHandler implementation which creates an Attachment for each attached page, collecting all created attachments into a list.

Author:

Bruce Chapman, Sudhan Moghe, Daniel Gredler, Ronald Brill, Lai Quang Duong

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollectingAttachmentHandler() Creates a new instance.
CollectingAttachmentHandler(List<Attachment> list) Creates a new instance which collects attachments into the specified list.

Method Summary

Modifier and Type	Method and Description
List<Attachment>	getCollectedAttachments() Returns the list of attachments collected by this attachment handler.
void	handleAttachment(Page page, String attachmentFilename) Handles the specified attached page.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.htmlunit.attachment.AttachmentHandler

handleAttachment, isAttachment

Constructor Detail

CollectingAttachmentHandler

public CollectingAttachmentHandler()

Creates a new instance.

CollectingAttachmentHandler

public CollectingAttachmentHandler(List<Attachment> list)

Creates a new instance which collects attachments into the specified list.

Parameters:

list - the list to store attachments in

Method Detail

handleAttachment

public void handleAttachment(Page page,
                             String attachmentFilename)

Handles the specified attached page. This is some kind of information that the page was handled as attachment. This method will only be called if AttachmentHandler.handleAttachment(WebResponse, String) has returned false for the response.

Specified by:

handleAttachment in interface AttachmentHandler

Parameters:

page - an attached page, which doesn't get loaded inline

attachmentFilename - the filename to use for the attachment or null if unspecified

getCollectedAttachments

public List<Attachment> getCollectedAttachments()

Returns the list of attachments collected by this attachment handler. The returned list is modifiable, so that attachments can be removed after being processed.

Returns:

the list of attachments collected by this attachment handler