net.sf.ij_plugins.util

Class Enumeration

java.lang.Object

net.sf.ij_plugins.util.Enumeration

Direct Known Subclasses:

MiBoolean, MiElementType, MiTag

public abstract class Enumeration
extends java.lang.Object

Abstract base class for representing enumeration. Based on pattern presented by Joshua Bloch in "Effective Java" 2001.

Since:

June 18, 2002

Author:

Jarek Sacha

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Enumeration(java.lang.String name) Constructor for the Enumeration object

Method Summary

Methods

Modifier and Type	Method and Description
Enumeration	byName(java.lang.String memberName) Returns a reference to the named member of this Enumeration, throes IllegalArgumentException of name is not found.
java.lang.String	toString() Return name a

Methods inherited from class java.lang.Object

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

Constructor Detail

Enumeration

protected Enumeration(java.lang.String name)

Constructor for the Enumeration object

Parameters:

name - Description of Parameter

Method Detail

byName

public final Enumeration byName(java.lang.String memberName)
                         throws java.lang.IllegalArgumentException

Returns a reference to the named member of this Enumeration, throes IllegalArgumentException of name is not found.

API NOTE: This method looks as it should have been defines as static. However, this could lead to an unpredictable behavior of this method due to the way Java initializes static member variables of a class. In particular, if this method was static it would be possible to call it before static member variables of the Enumeration class for which it was called were initialized. As a result if this method was static it could throw IllegalArgumentException even when its argument was a valid member name.

Parameters:

memberName - A name of the Enumeration member.

Returns:

Reference to a member with given memberName.

Throws:

java.lang.IllegalArgumentException - If a member with given memberName cannot be found.

toString

public final java.lang.String toString()

Return name a

Overrides:

toString in class java.lang.Object

Returns:

Description of the Returned Value