org.kitteh.irc.client.library.feature

Enum CaseMapping

java.lang.Object

java.lang.Enum<CaseMapping>

org.kitteh.irc.client.library.feature.CaseMapping

All Implemented Interfaces:

Serializable, Comparable<CaseMapping>

public enum CaseMapping
extends Enum<CaseMapping>

ISUPPORT CASEMAPPING.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCII A-Z become a-z
RFC1459 A-Z become a-z, []^ become {}~
STRICT_RFC1459 A-Z become a-z, [] become {}

Method Summary

Modifier and Type	Method and Description
boolean	areEqualIgnoringCase(@NonNull String one, @NonNull String two) Gets if two given strings are equal, case insensitive, using this case mapping.
static @NonNull Optional<CaseMapping>	getByName(@Nullable String name) Gets a CaseMapping by name.
@NonNull String	toLowerCase(@NonNull String input) Converts a given String to lowercase per spec.
static CaseMapping	valueOf(String name) Returns the enum constant of this type with the specified name.
static CaseMapping[]	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

ASCII

public static final CaseMapping ASCII

A-Z become a-z

RFC1459

public static final CaseMapping RFC1459

A-Z become a-z, []^ become {}~

STRICT_RFC1459

public static final CaseMapping STRICT_RFC1459

A-Z become a-z, [] become {}

Method Detail

values

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

Returns:

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

valueOf

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

getByName

public static @NonNull Optional<CaseMapping> getByName(@Nullable String name)

Gets a CaseMapping by name. Case insensitive.

Parameters:

name - the name of the CaseMapping to get

Returns:

the matching CaseMapping if one exists

areEqualIgnoringCase

public boolean areEqualIgnoringCase(@NonNull String one,
                                    @NonNull String two)

Gets if two given strings are equal, case insensitive, using this case mapping.

Parameters:

one - one string

two - two string, red string, blue string

Returns:

true if equal ignoring case using this case mapping

toLowerCase

public @NonNull String toLowerCase(@NonNull String input)

Converts a given String to lowercase per spec.

Parameters:

input - string to be lowercased

Returns:

lowercased string

Throws:

IllegalArgumentException - if input is null