com.screenscraper.events.scrapeablefile

Class ScrapeableFileEventData

java.lang.Object

java.util.EventObject

com.screenscraper.events.AbstractEventData

com.screenscraper.events.scrapeablefile.ScrapeableFileEventData

All Implemented Interfaces:

java.io.Serializable

public class ScrapeableFileEventData
extends AbstractEventData

Data class for scrapeable file events

Version:

6.0.55a

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ScrapeableFileEventData(ScrapingSession session, ScrapeableFile scrapeableFile, java.lang.String redirectToURL, java.lang.String httpResponseData, ScrapingRequest.Builder redirectRequestBuilder)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHttpResponseData() Returns the response string after a request (null if this event doesn't deal with the response, or if the request totally failed)
ScrapingRequest.Builder	getRedirectRequestBuilder() Returns the RedirectRequestBuilder for the object.
java.lang.String	getRedirectToURL() Returns the URL that will be redirected to (if the event happens during a redirect), null otherwise
ScrapeableFile	getScrapeableFile() Returns the current scrapeable file on which the event was triggered
ScrapingSession	getSession() Returns the current scraping session on which the event was triggered
java.lang.String	toString()

Methods inherited from class com.screenscraper.events.AbstractEventData

getLastReturnValue, setLastReturnValue

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ScrapeableFileEventData

ScrapeableFileEventData(@NotNull
                        ScrapingSession session,
                        @NotNull
                        ScrapeableFile scrapeableFile,
                        @Nullable
                        java.lang.String redirectToURL,
                        @Nullable
                        java.lang.String httpResponseData,
                        @Nullable
                        ScrapingRequest.Builder redirectRequestBuilder)

Method Detail

getSession

@NotNull
public ScrapingSession getSession()

Returns the current scraping session on which the event was triggered

Returns:

The current scraping session on which the event was triggered

getScrapeableFile

@NotNull
public ScrapeableFile getScrapeableFile()

Returns the current scrapeable file on which the event was triggered

Returns:

The current scrapeable file on which the event was triggered

getRedirectToURL

@Nullable
public java.lang.String getRedirectToURL()

Returns the URL that will be redirected to (if the event happens during a redirect), null otherwise

Returns:

The URL that will be redirected to (if the event happens during a redirect), null otherwise

getRedirectRequestBuilder

@Nullable
public ScrapingRequest.Builder getRedirectRequestBuilder()

Returns the RedirectRequestBuilder for the object. Use this to add headers, etc... for the redirect. It can be null depending on the HTTP client being used, and whether or not it supports manually playing with the redirect

Returns:

The RedirectRequestBuilder for the object

getHttpResponseData

@Nullable
public java.lang.String getHttpResponseData()

Returns the response string after a request (null if this event doesn't deal with the response, or if the request totally failed)

Returns:

The response string after a request (null if this event doesn't deal with the response, or if the request totally failed)

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.util.EventObject