com.screenscraper.util.parsing.name

Enum NameParserEnum

java.lang.Object

java.lang.Enum<NameParserEnum>

com.screenscraper.util.parsing.name.NameParserEnum

All Implemented Interfaces:

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

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

Name parser with default parse formats

Version:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
English Represents a parser to handle english names.

Method Summary

Modifier and Type	Method and Description
abstract Name	parse(java.lang.String name) Parses the text as a name and returns it as a Name object
static NameParserEnum	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NameParserEnum[]	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

English

public static final NameParserEnum English

Represents a parser to handle english names. This generally also works for other names

Method Detail

values

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

Returns:

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

valueOf

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

parse

@Nullable
 @RequiredVersion(value=1)
public abstract Name parse(@NotNull
                                                                  java.lang.String name)

Parses the text as a name and returns it as a Name object

Parameters:

name - The string representing the name

Returns:

The Name object that corresponds to the entered string

Throws:

java.lang.IllegalArgumentException - If the name cannot be parsed