com.hfg.html.attribute.VAlign Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.html.attribute;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

import com.hfg.html.HTML;

//------------------------------------------------------------------------------
/**
 * Enum-like alignment class
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------
//
//
// 
// 

public final class VAlign implements Serializable
{

    private String mName;
    private int    mIndex;
    
    private static Map sValueMap = new HashMap<>(11);

    public static final VAlign BASELINE    = new VAlign("baseline");
    public static final VAlign BOTTOM      = new VAlign("bottom");
    public static final VAlign INHERIT     = new VAlign("inherit");
    public static final VAlign INITIAL     = new VAlign("initial");
    public static final VAlign MIDDLE      = new VAlign("middle");
    public static final VAlign SUB         = new VAlign("sub");
    public static final VAlign SUPER       = new VAlign("super");
    public static final VAlign TEXT_BOTTOM = new VAlign("text-bottom");
    public static final VAlign TEXT_TOP    = new VAlign("text-top");
    public static final VAlign TOP         = new VAlign("top");
    public static final VAlign UNSET       = new VAlign("unset");

    //###########################################################################
    // CONSTRUCTORS
    //###########################################################################

    //--------------------------------------------------------------------------    
    private VAlign(String inName)
    {
        mName = inName;
        mIndex = sValueMap.size();
        sValueMap.put(inName, this);
    }

    //###########################################################################
    // PUBLIC METHODS
    //###########################################################################

    //--------------------------------------------------------------------------
    public static VAlign[] values()
    {
        return sValueMap.values().toArray(new VAlign[] {});
    }

    //--------------------------------------------------------------------------
    public static VAlign valueOf(String inValue)
    {
        return sValueMap.get(inValue);
    }

    //--------------------------------------------------------------------------
    @Override
    public final String toString()
    {
        return mName;
    }

    //--------------------------------------------------------------------------
    public final String getHTMLAttributeName()
    {
        return HTML.VALIGN;
    }
    
    //--------------------------------------------------------------------------
    @Override
    public final int hashCode()
    {
        return super.hashCode();
    }
    
    //--------------------------------------------------------------------------
    @Override
    public final boolean equals(Object inObj)
    {
        VAlign o2 = (VAlign) inObj;
        return (mIndex == o2.mIndex);
    }
    
    //--------------------------------------------------------------------------
    /**
     * This method is called after de-serialization, allowing the object
     * to nominate a replacement object to be used in the output
     * graph instead of this object. We don't want multiple objects of each type
     * to exist in a target VM, so instances replace themselves with
     * local objects.
     */
    private Object readResolve()
    {
        Object value = null;
        for (VAlign vAlign : values())
        {
            if (vAlign.mIndex == mIndex)
            {
                value = vAlign;
                break;
            }
        }

        return value;
    }
}