com.norconex.collector.http.sitemap

Enum SitemapChangeFrequency

java.lang.Object

java.lang.Enum<SitemapChangeFrequency>

com.norconex.collector.http.sitemap.SitemapChangeFrequency

All Implemented Interfaces:

Serializable, Comparable<SitemapChangeFrequency>

public enum SitemapChangeFrequency
extends Enum<SitemapChangeFrequency>

Sitemap change frequency unit, as defined on http://www.sitemaps.org/protocol.html

Since:

2.5.0

Author:

Pascal Essiembre

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS
DAILY
HOURLY
MONTHLY
NEVER
WEEKLY
YEARLY

Method Summary

Modifier and Type	Method and Description
static SitemapChangeFrequency	getChangeFrequency(String frequency) Gets the sitemap change frequency matching the supplied string.
static SitemapChangeFrequency	valueOf(String name) Returns the enum constant of this type with the specified name.
static SitemapChangeFrequency[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS

public static final SitemapChangeFrequency ALWAYS

HOURLY

public static final SitemapChangeFrequency HOURLY

DAILY

public static final SitemapChangeFrequency DAILY

WEEKLY

public static final SitemapChangeFrequency WEEKLY

MONTHLY

public static final SitemapChangeFrequency MONTHLY

YEARLY

public static final SitemapChangeFrequency YEARLY

NEVER

public static final SitemapChangeFrequency NEVER

Method Detail

values

public static SitemapChangeFrequency[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SitemapChangeFrequency c : SitemapChangeFrequency.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SitemapChangeFrequency valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getChangeFrequency

public static SitemapChangeFrequency getChangeFrequency(String frequency)

Gets the sitemap change frequency matching the supplied string. Has the same effect as valueOf(String) except that it will return null when no matches are found.

Parameters:

frequency - change frequency

Returns:

the matching sitemap change frequency, or null