com.comphenix.protocol

Class PacketTypeEnum

java.lang.Object

com.comphenix.protocol.PacketTypeEnum

All Implemented Interfaces:

Iterable<PacketType>

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 PacketTypeEnum
extends Object
implements Iterable<PacketType>

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 Set<PacketType>	members

Constructor Summary

Constructors

Constructor and Description
PacketTypeEnum() Registers every declared PacketType field.

Method Summary

Modifier and Type	Method and Description
boolean	hasMember(PacketType member) Determines whether or not the given member has been registered to this enum.
Iterator<PacketType>	iterator()
protected void	registerAll() Registers every public assignable static field as a member.
boolean	registerMember(PacketType instance, String name) Registers a member if its not present.
PacketType	valueOf(String name) Deprecated. Don't use this
Set<PacketType>	values() Retrieve every registered member.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

members

protected Set<PacketType> members

Constructor Detail

PacketTypeEnum

public PacketTypeEnum()

Registers every declared PacketType field.

Method Detail

registerAll

protected void registerAll()

Registers every public assignable static field as a member.

registerMember

public boolean registerMember(PacketType instance,
                              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(PacketType 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

@Deprecated
public PacketType valueOf(String name)

Deprecated. Don't use this

Retrieve a member by name,

Parameters:

name - - name of member to retrieve.

Returns:

The member, or NULL if not found.

values

public Set<PacketType> values()

Retrieve every registered member.

Returns:

Enumeration of every value.

iterator

public Iterator<PacketType> iterator()

Specified by:

iterator in interface Iterable<PacketType>