com.redfin.sitemapgenerator

Class SitemapIndexGenerator.Options

java.lang.Object

com.redfin.sitemapgenerator.SitemapIndexGenerator.Options

Enclosing class:

SitemapIndexGenerator

public static class SitemapIndexGenerator.Options
extends Object

Options to configure sitemap index generation

Constructor Summary

Constructors

Constructor and Description
Options(String baseUrl, File outFile) Configures the generator with a base URL and destination to write the sitemap index file.
Options(URL baseUrl, File outFile) Configures the generator with a base URL and destination to write the sitemap index file.

Method Summary

Modifier and Type	Method and Description
SitemapIndexGenerator.Options	autoValidate(boolean autoValidate) Validate the sitemap index automatically after writing it; this takes time
SitemapIndexGenerator	build() Constructs a sitemap index generator configured with the options you specified
SitemapIndexGenerator.Options	dateFormat(W3CDateFormat dateFormat) The date formatter, typically configured with a W3CDateFormat.Pattern and/or a time zone
SitemapIndexGenerator.Options	defaultLastMod(Date defaultLastMod) The default lastMod date for sitemap indexes; the default default is now, but you can pass in null to omit a lastMod entirely.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options(URL baseUrl,
               File outFile)

Configures the generator with a base URL and destination to write the sitemap index file.

Parameters:

baseUrl - All URLs in the generated sitemap(s) should appear under this base URL

outFile - The sitemap index will be written out at this location

Options

public Options(String baseUrl,
               File outFile)
        throws MalformedURLException

Configures the generator with a base URL and destination to write the sitemap index file.

Parameters:

baseUrl - All URLs in the generated sitemap(s) should appear under this base URL

outFile - The sitemap index will be written out at this location

Throws:

MalformedURLException

Method Detail

dateFormat

public SitemapIndexGenerator.Options dateFormat(W3CDateFormat dateFormat)

The date formatter, typically configured with a W3CDateFormat.Pattern and/or a time zone

defaultLastMod

public SitemapIndexGenerator.Options defaultLastMod(Date defaultLastMod)

The default lastMod date for sitemap indexes; the default default is now, but you can pass in null to omit a lastMod entirely. We don't recommend this; Google may not like you as much.

autoValidate

public SitemapIndexGenerator.Options autoValidate(boolean autoValidate)

Validate the sitemap index automatically after writing it; this takes time

build

public SitemapIndexGenerator build()

Constructs a sitemap index generator configured with the options you specified