com.github.theholywaffle.teamspeak3.api

Enum ChannelBannerMode

java.lang.Object

java.lang.Enum<ChannelBannerMode>

com.github.theholywaffle.teamspeak3.api.ChannelBannerMode

All Implemented Interfaces:

Serializable, Comparable<ChannelBannerMode>

public enum ChannelBannerMode
extends Enum<ChannelBannerMode>

The values in this enum are speculative. There does not appear to be any documentation on channel banner modes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE_ASPECT
KEEP_ASPECT
NO_ADJUST
UNKNOWN An unknown channel banner mode.

Method Summary

Modifier and Type	Method and Description
int	getIndex()
static ChannelBannerMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChannelBannerMode[]	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

NO_ADJUST

public static final ChannelBannerMode NO_ADJUST

IGNORE_ASPECT

public static final ChannelBannerMode IGNORE_ASPECT

KEEP_ASPECT

public static final ChannelBannerMode KEEP_ASPECT

UNKNOWN

public static final ChannelBannerMode UNKNOWN

An unknown channel banner mode.

If you ever encounter an unknown banner mode, please tell us! We may have to update the API.

Method Detail

values

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

Returns:

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

valueOf

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

getIndex

public int getIndex()