net.pieroxy.ua.detection

Enum BotFamily

java.lang.Object

java.lang.Enum<BotFamily>

net.pieroxy.ua.detection.BotFamily

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BotFamily>

public enum BotFamily
extends java.lang.Enum<BotFamily>

Describes the family of the bot, its nature.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CRAWLER A robot used to crawl the web (Google's crawler, Bing's crawler, etc.)
FEED_CRAWLER Feed aggregator (Feedly, ...)
HIDDEN_BOT A robot that hides as a regular browser.
NOT_A_BOT This UserAgentDetectionResult does not depict a bot:
ROBOT A generic robot.
SPAMBOT A spam bot.
UNKNOWN Unknown type of bot

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getLabel()
boolean	isNefarious()
static BotFamily	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BotFamily[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROBOT

public static final BotFamily ROBOT

A generic robot.

SPAMBOT

public static final BotFamily SPAMBOT

A spam bot.

HIDDEN_BOT

public static final BotFamily HIDDEN_BOT

A robot that hides as a regular browser. There are considered to be nefarious (because they hide.)

CRAWLER

public static final BotFamily CRAWLER

A robot used to crawl the web (Google's crawler, Bing's crawler, etc.)

FEED_CRAWLER

public static final BotFamily FEED_CRAWLER

Feed aggregator (Feedly, ...)

UNKNOWN

public static final BotFamily UNKNOWN

Unknown type of bot

NOT_A_BOT

public static final BotFamily NOT_A_BOT

This UserAgentDetectionResult does not depict a bot:

Method Detail

values

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

Returns:

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

valueOf

public static BotFamily valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

isNefarious

public boolean isNefarious()

Returns:

true if the bot is of the nefarious type.

getLabel

public java.lang.String getLabel()

Returns:

the text-based description of this bot.