Field Detail

• MAX_SITEMAPS_PER_INDEX

  public static final int MAX_SITEMAPS_PER_INDEX

  Maximum 50,000 sitemaps per index allowed

  See Also:

  Constant Field Values

Constructor Detail

• SitemapIndexGenerator

  public SitemapIndexGenerator(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

• SitemapIndexGenerator

  public SitemapIndexGenerator(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

• addUrl

  public SitemapIndexGenerator addUrl(SitemapIndexUrl url)

  Adds a single sitemap to the index

• addUrls

  public SitemapIndexGenerator addUrls(Iterable<? extends SitemapIndexUrl> urls)

  Add multiple sitemaps to the index

• addUrls

  public SitemapIndexGenerator addUrls(SitemapIndexUrl... urls)

  Add multiple sitemaps to the index

• addUrls

  public SitemapIndexGenerator addUrls(String... urls)
                                throws MalformedURLException

  Add multiple sitemaps to the index

  Throws:

  MalformedURLException

• addUrl

  public SitemapIndexGenerator addUrl(String url)
                               throws MalformedURLException

  Adds a single sitemap to the index

  Throws:

  MalformedURLException

• addUrls

  public SitemapIndexGenerator addUrls(URL... urls)

  Add multiple sitemaps to the index

• addUrl

  public SitemapIndexGenerator addUrl(URL url)

  Adds a single sitemap to the index

• addUrl

  public SitemapIndexGenerator addUrl(URL url,
                                      Date lastMod)

  Adds a single sitemap to the index

• addUrl

  public SitemapIndexGenerator addUrl(String url,
                                      Date lastMod)
                               throws MalformedURLException

  Adds a single sitemap to the index

  Throws:

  MalformedURLException

• addUrls

  public SitemapIndexGenerator addUrls(String prefix,
                                       String suffix,
                                       int count)

  Add a numbered list of sitemaps to the index, e.g. "sitemap1.xml" "sitemap2.xml" "sitemap3.xml" etc.

  Parameters:

  prefix - the first part of the filename e.g. "sitemap"

  suffix - the last part of the filename e.g. ".xml" or ".xml.gz"

  count - the number of sitemaps (1-based)

• write

  public void write()

  Writes out the sitemap index