Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /* NOTICE: This file has been changed by Plutext Pty Ltd for use in docx4j.
   * The package name has been changed; there may also be other changes.
   * 
   * This notice is included to meet the condition in clause 4(b) of the License. 
   */
  
   /*
   * Copyright 1997-2004 The Apache Software Foundation
   * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  * 
  *     http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 /* NOTICE: This file has been changed by Plutext Pty Ltd for use in docx4j.
  * 
  * This notice is included to meet the condition in clause 4(b) of the License. 
  */
 
 //package org.apache.avalon.framework;
 package org.docx4j.fonts.fop.fonts;
 
 import java.util.Map;

Basic enum class for type-safe enums. Should be used as an abstract base. For example:
 import org.apache.avalon.framework.Enum;

 public final class Color extends Enum {
   public static final Color RED = new Color( "Red" );
   public static final Color GREEN = new Color( "Green" );
   public static final Color BLUE = new Color( "Blue" );

   private Color( final String color )
   {
     super( color );
   }
 }
 
If further operations, such as iterating over all items, are required, the Enum(java.lang.String,java.util.Map) constructor can be used to populate a Map, from which further functionality can be derived:
 public final class Color extends Enum {
   static final Map map = new HashMap();

   public static final Color RED = new Color( "Red", map );
   public static final Color GREEN = new Color( "Green", map );
   public static final Color BLUE = new Color( "Blue", map );

   private Color( final String color, final Map map )
   {
     super( color, map );
   }

   public static Iterator iterator()
   {
     return map.values().iterator();
   }
 }
 

NOTE: between 4.0 and 4.1, the constructors' access has been changed from public to protected. This is to prevent users of the Enum breaking type-safety by defining new Enum items. All Enum items should be defined in the Enum class, as shown above.

Author(s):
Avalon Development Team
Version:
$Id$
 
 public abstract class Enum
 {
    
The string representation of the Enum.
 
     private final String m_name;

    
Constructor to add a new named item.

Note: access changed from public to protected after 4.0. See class description.

Parameters:
name Name of the item.
    protected Enumfinal String name )
    {
        thisnamenull );
    }

    
Constructor to add a new named item.

Note: access changed from public to protected after 4.0. See class description.

Parameters:
name Name of the item.
map A Map, to which will be added a pointer to the newly constructed object.
    protected Enumfinal String namefinal Map map )
    {
         = name;
        ifnull != map )
        {
            map.putnamethis );
        }
    }

    
Tests for equality. Two Enum:s are considered equal if they are of the same class and have the same names. The method is also declared final - I (LSutic) did this to allow the JIT to inline it easily.

Parameters:
o the other object
Returns:
the equality status
    public boolean equalsObject o )
    {
        ifthis == o )
            return true;
        if( !(o instanceof Enum) )
            return false;
        final Enum enumerated = (Enum)o;
        if( !getClass().equalsenumerated.getClass() ) )
            return false;
        if != null ? !.equalsenumerated.m_name ) : enumerated.m_name != null )
            return false;
        return true;
    }
    public int hashCode()
    {
        int result;
        result = ( != null ? .hashCode() : 0);
        result = 29 * result + getClass().hashCode();
        return result;
    }

    
Returns a hash code value for the object.

Returns:
a hash code value for this object
    /*public int hashCode()
    {
        return m_name.hashCode() ^ this.getClass().getName().hashCode();
    }*/

    
Retrieve the name of this Enum item, set in the constructor.

Returns:
the name String of this Enum item
    public final String getName()
    {
        return ;
    }

    
Human readable description of this Enum item. For use when debugging.

Returns:
String in the form type[name], eg.: Color[Red].
    public String toString()
    {
        return getClass().getName() + "[" +  + "]";
    }
New to GrepCode? Check out our FAQ X