com.esri.gpt.framework.robots
Enum BotsMode

java.lang.Object
  java.lang.Enum<BotsMode>
      com.esri.gpt.framework.robots.BotsMode

All Implemented Interfaces:

Serializable, Comparable<BotsMode>

public enum BotsMode
extends Enum<BotsMode>

RobotsTxt mode.

Controls how robots.txt should be respected during harvesting.

inherit uses "bot.robotstxt.enabled" parameter from gpt.xml configuration file.

Enum Constant Summary

always
force to use robots.txt if available robots.txt available, regardless default configuration

inherit
inherit from gpt.xml => bot.robotstxt.enabled

never
disable to use robots.txt if available robots.txt available, regardless default configuration

Method Summary

static BotsMode	getDefault() Gets default value.
static BotsMode	parseMode(String mode) Parse string into mode.
static BotsMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BotsMode[]	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

inherit

public static final BotsMode inherit

inherit from gpt.xml => bot.robotstxt.enabled

always

public static final BotsMode always

force to use robots.txt if available robots.txt available, regardless default configuration

never

public static final BotsMode never

disable to use robots.txt if available robots.txt available, regardless default configuration

Method Detail

values

public static BotsMode[] 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 (BotsMode c : BotsMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static BotsMode 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

getDefault

public static BotsMode getDefault()

Gets default value.

Returns:

RobotsTxtMode#inherit

parseMode

public static BotsMode parseMode(String mode)

Parse string into mode. Default: RobotsTxtMode#inherit.

Parameters:

mode - mode as text

Returns:

mode