com.comphenix.protocol.reflect

Class ObjectEnum<T>

java.lang.Object

com.comphenix.protocol.reflect.ObjectEnum<T>

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

PacketType.Handshake.Client, PacketType.Handshake.Server, PacketType.Legacy.Client, PacketType.Legacy.Server, PacketType.Login.Client, PacketType.Login.Server, PacketType.Play.Client, PacketType.Play.Server, PacketType.Status.Client, PacketType.Status.Server

public class ObjectEnum<T>
extends java.lang.Object
implements java.lang.Iterable<T>

Represents a more modern object-based enum.

This is useful if you want the flexibility of a modern Java enum, but don't want to prevent the creation of additional members dynamically.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.collect.BiMap<T,java.lang.String>	members

Constructor Summary

Constructors

Constructor and Description
ObjectEnum(java.lang.Class<T> fieldType) Registers every declared integer field.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDeclaredName(T member) Retrieve the name of the given member.
boolean	hasMember(T member) Determines whether or not the given member has been registered to this enum.
java.util.Iterator<T>	iterator()
protected void	registerAll(java.lang.Class<T> fieldType) Registers every public assignable static field as a member.
boolean	registerMember(T instance, java.lang.String name) Registers a member if its not present.
T	valueOf(java.lang.String name) Retrieve a member by name,
java.util.Set<T>	values() Retrieve every registered member.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

members

protected com.google.common.collect.BiMap<T,java.lang.String> members

Constructor Detail

ObjectEnum

public ObjectEnum(java.lang.Class<T> fieldType)

Registers every declared integer field.

Method Detail

registerAll

protected void registerAll(java.lang.Class<T> fieldType)

Registers every public assignable static field as a member.

registerMember

public boolean registerMember(T instance,
                     java.lang.String name)

Registers a member if its not present.

Parameters:

instance - - member instance.

name - - name of member.

Returns:

TRUE if the member was registered, FALSE otherwise.

hasMember

public boolean hasMember(T member)

Determines whether or not the given member has been registered to this enum.

Parameters:

member - - the member to check.

Returns:

TRUE if the given member has been registered, FALSE otherwise.

valueOf

public T valueOf(java.lang.String name)

Retrieve a member by name,

Parameters:

name - - name of member to retrieve.

Returns:

The member, or NULL if not found.

getDeclaredName

public java.lang.String getDeclaredName(T member)

Retrieve the name of the given member.

Parameters:

member - - the member to retrieve.

Returns:

Declared name of the member, or NULL if not found.

values

public java.util.Set<T> values()

Retrieve every registered member.

Returns:

Enumeration of every value.

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>