Package cz.jiripinkas.jsitemapgenerator

Class AbstractSitemapGenerator<T extends AbstractGenerator>

    • Constructor Detail

      • AbstractSitemapGenerator

        public AbstractSitemapGenerator​(String baseUrl)

    • Method Detail

      • toStringArray

        public abstract String[] toStringArray()

      • constructSitemapString

        @Deprecated
public String constructSitemapString()
        Deprecated.
        Use toString() instead
        Construct sitemap into single String
        Returns:
        sitemap

      • toString

        public String toString()
        Construct sitemap into single String
        Overrides:
        toString in class Object
        Returns:
        sitemap

      • constructSitemapGzip

        @Deprecated
public byte[] constructSitemapGzip()
        Deprecated.
        Use toGzipByteArray() instead
        Construct sitemap into gzipped file
        Returns:
        byte array

      • toGzipByteArray

        public byte[] toGzipByteArray()
        Construct sitemap into gzipped file
        Returns:
        byte array

      • saveSitemap

        @Deprecated
public void saveSitemap​(File file,
                        String[] sitemap)
                 throws IOException
        Deprecated.
        Use toFile(Path) instead
        Save sitemap to output file
        Parameters:
        file - Output file
        sitemap - Sitemap as array of Strings (created by constructSitemap() method)
        Throws:
        IOException - when error

      • toFile

        public void toFile​(File file)
            throws IOException
        Construct and save sitemap to output file
        Parameters:
        file - Output file
        Throws:
        IOException - when error

      • toFile

        public void toFile​(Path path)
            throws IOException
        Construct and save sitemap to output file
        Parameters:
        path - Output file
        Throws:
        IOException - when error

      • constructAndSaveSitemap

        @Deprecated
public void constructAndSaveSitemap​(File file)
                             throws IOException
        Deprecated.
        Use toFile(File) instead
        Construct and save sitemap to output file
        Parameters:
        file - Output file
        Throws:
        IOException - when error

      • constructAndSaveSitemap

        @Deprecated
public void constructAndSaveSitemap​(Path path)
                             throws IOException
        Deprecated.
        Use toFile(Path) instead
        Construct and save sitemap to output file
        Parameters:
        path - Output file
        Throws:
        IOException - when error

      • pingGoogle

        public void pingGoogle​(String sitemapUrl)
        Ping Google that sitemap has changed. Will call this URL: https://www.google.com/ping?sitemap=URL_Encoded_sitemapUrl
        Parameters:
        sitemapUrl - sitemap url

      • pingBing

        public void pingBing​(String sitemapUrl)
        Ping Bing that sitemap has changed. Will call this URL: http://www.bing.com/ping?sitemap=URL_Encoded_sitemapUrl
        Parameters:
        sitemapUrl - sitemap url

      • pingGoogle

        public void pingGoogle()
        Ping Google that sitemap has changed. Sitemap must be on this location: baseUrl/sitemap.xml (for example http://www.javavids.com/sitemap.xml)

      • pingBing

        public void pingBing()
        Ping Google that sitemap has changed. Sitemap must be on this location: baseUrl/sitemap.xml (for example http://www.javavids.com/sitemap.xml)

      • escapeXmlSpecialCharacters

        protected String escapeXmlSpecialCharacters​(String url)
        Escape special characters in XML
        Parameters:
        url - Url to be escaped
        Returns:
        Escaped url

      • defaultDir

        public T defaultDir​(String dirName)
        Sets default prefix dir to name for all subsequent WebPages. Final name will be "dirName/name"
        Parameters:
        dirName - Dir name
        Returns:
        this

      • defaultDir

        public T defaultDir​(String... dirNames)
        Sets default prefix dirs to name for all subsequent WebPages. For dirs: ["a", "b", "c"], the final name will be "a/b/c/name"
        Parameters:
        dirNames - Dir names
        Returns:
        this

      • resetDefaultDir

        public T resetDefaultDir()
        Reset default dir value
        Returns:
        this

      • defaultExtension

        public T defaultExtension​(String extension)
        Sets default suffix extension for all subsequent WebPages. Final name will be "name.extension"
        Parameters:
        extension - Extension
        Returns:
        this

      • resetDefaultExtension

        public T resetDefaultExtension()
        Reset default extension value
        Returns:
        this

      • defaultPriorityMax

        public T defaultPriorityMax()
        Sets default priority for all subsequent WebPages to maximum (1.0)
        Returns:
        this

      • defaultPriority

        public T defaultPriority​(Double priority)
        Sets default priority for all subsequent WebPages
        Parameters:
        priority - Default priority
        Returns:
        this

      • resetDefaultPriority

        public T resetDefaultPriority()
        Reset default priority
        Returns:
        this

      • defaultChangeFreq

        public T defaultChangeFreq​(ChangeFreq changeFreq)
        Sets default changeFreq for all subsequent WebPages
        Parameters:
        changeFreq - ChangeFreq
        Returns:
        this

      • defaultChangeFreqAlways

        public T defaultChangeFreqAlways()
        Sets default changeFreq to ALWAYS for all subsequent WebPages
        Returns:
        this

      • defaultChangeFreqHourly

        public T defaultChangeFreqHourly()
        Sets default changeFreq to HOURLY for all subsequent WebPages
        Returns:
        this

      • defaultChangeFreqDaily

        public T defaultChangeFreqDaily()
        Sets default changeFreq to DAILY for all subsequent WebPages
        Returns:
        this

      • defaultChangeFreqWeekly

        public T defaultChangeFreqWeekly()
        Sets default changeFreq to WEEKLY for all subsequent WebPages
        Returns:
        this

      • defaultChangeFreqMonthly

        public T defaultChangeFreqMonthly()
        Sets default changeFreq to MONTHLY for all subsequent WebPages
        Returns:
        this

      • defaultChangeFreqYearly

        public T defaultChangeFreqYearly()
        Sets default changeFreq to YEARLY for all subsequent WebPages
        Returns:
        this

      • defaultChangeFreqNever

        public T defaultChangeFreqNever()
        Sets default changeFreq to NEVER for all subsequent WebPages
        Returns:
        this

      • resetDefaultChangeFreq

        public T resetDefaultChangeFreq()
        Reset default changeFreq
        Returns:
        this

      • defaultLastMod

        public T defaultLastMod​(Date lastMod)
        Sets default lastMod for all subsequent WebPages
        Parameters:
        lastMod - lastMod
        Returns:
        this

      • defaultLastMod

        public T defaultLastMod​(java.time.LocalDateTime lastMod)
        Sets default lastMod for all subsequent WebPages
        Parameters:
        lastMod - lastMod
        Returns:
        this

      • defaultLastModNow

        public T defaultLastModNow()
        Sets default lastMod = new Date() for all subsequent WebPages
        Returns:
        this

      • resetDefaultLastMod

        public T resetDefaultLastMod()
        Reset default lastMod
        Returns:
        this