/*
 * [Semicolon.java]
 *
 * Summary: Describes one Semicolon Token to display semicolons distinctly from colons and other punct.
 *
 * Copyright: (c) 2004-2017 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.8+
 *
 * Created with: JetBrains IntelliJ IDEA IDE http://www.jetbrains.com/idea/
 *
 * Version History:
 *  2.0 2009-04-19 tidy comments, more accurate colour names
 */
package com.mindprod.jtokens;

import java.awt.Color;

import static com.mindprod.jtokens.TokenColourScheme.COMMON_FOREGROUND_FOR_SEMICOLON;

/**
 * Describes one Semicolon Token to display semicolons distinctly from colons and other punct.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 2.0 2009-04-19 tidy comments, more accurate colour names
 * @since 2004-04-24
 */
public final class Semicolon extends Operator
    {
    /**
     * version number for this class
     */
    static final long serialVersionUID = 1L;

    /**
     * Constructor
     */
    public Semicolon()
        {
        super( ';' );
        }

    /**
     * foreground colour to render this token.
     *
     * @return Color object.
     */
    public Color getForeground()
        {
        // make semicolons distinct from colon
        return COMMON_FOREGROUND_FOR_SEMICOLON;
        }

    /**
     * get the text surrounded by CSS html
     *
     * @return decorated HTML in a <span sandwich
     */
    public String getHTML()
        {
        /**
         * make semicolon look distinct from colon
         */
        return "<span class=\"sc\">" + getText() + "</span>";
        }
    }