org.softsmithy.lib.util

Class TypesafeEnum

java.lang.Object

org.softsmithy.lib.util.TypesafeEnum

All Implemented Interfaces:

Localizable

Direct Known Subclasses:

HorizontalAlignment, IconType, JFontChooser.FontStyle, Line2DOrientation, Option, ScalingAlgorithm, SplitOrientation, StandardActionFactory, VerticalAlignment

Deprecated.

@Deprecated
public class TypesafeEnum
extends Object
implements Localizable

Base class for typsafe enums.
Helps documenting the purpose of a subclass.
Subclasses should have only private (if fixed), protected (if extensible) or package-private (if extensible only inside the package) constructors to implement the typesafe enum pattern.
More to read about the typesafe enum pattern: Item 21 (chapter 5, p.104) of the Java Series Book Effective Java Programming Language Guide by Joshua Bloch.
Serialization note: Subclasses implementing Serializable should deserialize to the rigth static field as the deserialized version of an object of this class would neither have set the right name attribute (only the parameterless constructor gets called) nor would it fulfill the equals contract.
eg.:

  import java.io.Serializable;
  import java.io.ObjectStreamException;

  import puce.util.TypesafeEnum;

  public class Foo extends TypesafeEnum implements Serializable{

    private Foo(String name){
      super(name);
    }

    public static final Foo BAR = new Foo("bar"){
      private Object readResolve() throws ObjectStreamException{
        return Foo.BAR;
      }
    }
  }
  

Note:This serialization tip has not been tested yet!

Copyright: Copyright (c) 2002

Author:

Florian Brunner

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TypesafeEnum() Deprecated.
protected	TypesafeEnum(String name) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Deprecated. All equal objects of the enumerated type are also identical (a.equals(b) if and only if a==b).
String	getDisplayString(Locale locale) Deprecated. Returns a string that is appropriate to display to the user.
String	getResourceBundleBaseName() Deprecated.
int	hashCode() Deprecated.
String	toString() Deprecated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TypesafeEnum

protected TypesafeEnum(String name)

Deprecated.

TypesafeEnum

protected TypesafeEnum()

Deprecated.

Method Detail

getDisplayString

public String getDisplayString(Locale locale)

Deprecated.

Description copied from interface: Localizable

Returns a string that is appropriate to display to the user. If possible, the string returned will be localized according to inLocale.

Specified by:

getDisplayString in interface Localizable

Parameters:

locale - the string returned will be localized according to this value, if possible

Returns:

a string that is appropriate to display to the user.

getResourceBundleBaseName

public String getResourceBundleBaseName()

Deprecated.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

equals

public final boolean equals(Object obj)

Deprecated.

All equal objects of the enumerated type are also identical (a.equals(b) if and only if a==b).

Overrides:

equals in class Object

hashCode

public final int hashCode()

Deprecated.

Overrides:

hashCode in class Object