/**************************************************************************************************
 **
 ** $Id: LineCap.java 831 2006-05-01 00:27:23Z Desruisseaux $
 **
 ** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/go/display/style/LineCap.java $
 **
 ** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
 ** All Rights Reserved. http://www.opengis.org/legal/
 **
 *************************************************************************************************/
package org.opengis.go.display.style;

// J2SE direct dependencies
import java.util.ArrayList;
import java.util.List;

import org.opengis.util.CodeList;
import org.opengis.util.SimpleEnumerationType;


/**
 * Instances of LineCap indicate the various
 * ways of capping the end of a styled line. This class defines static
 * constants for all of the standard choices.
 *
 * @author OpenGIS® consortium
 * @version $Revision: 658 $, $Date: 2006-02-23 12:09:34 +1100 (jeu., 23 févr. 2006) $
 */
public class LineCap extends SimpleEnumerationType {
    /**
     * Serial number for compatibility with different versions.
     */
    private static final long serialVersionUID = 7111743758813550715L;

    //*************************************************************************
    //  Static Fields
    //*************************************************************************
    /**
     * The list of enumeration available in this virtual machine.
     * Must be declared first!.
     */
    private static final List VALUES = new ArrayList(3);

    /**
     * This constant indicates that line ends should be drawn with no extra
     * decoration.
     */
    public static final LineCap BUTT = new LineCap("BUTT", "Draw line ends with no decoration.");

    /**
     * This constant indicates that line ends should be drawn with a half
     * circle of diameter equal to the width of the line.
     */
    public static final LineCap ROUND = new LineCap("ROUND", "Draw line ends with half circles.");

    /**
     * This constant indicates that the line should be capped by a straight
     * line extending half the line's width past the endpoint of the line.
     */
    public static final LineCap SQUARE =
            new LineCap("SQUARE", "Draw line ends with a square cap.");

    //*************************************************************************
    //  Constructor
    //*************************************************************************

    /**
     * Construct a new LineCap with the given name and description.
     * This constructor should only be used to make the static
     * constants in this class or by a provider subclasses to create
     * implementation specific styles that can be accessed by
     * DisplayCapabilities.getSupportedLineCaps().
     * @param name a String defining the name of the Arrow pattern.
     * @param description a String describing the pattern.
     */
    protected LineCap(String name, String description) {
        super(VALUES, name, description);
    }

    //*************************************************************************
    //  Methods
    //*************************************************************************

    /**
     * Returns the list of LineCaps.
     */
    public static LineCap[] values() {
        synchronized (VALUES) {
            return (LineCap[]) VALUES.toArray(new LineCap[VALUES.size()]);
        }
    }

    /**
     * Returns the list of enumerations of the same kind than this enum.
     */
    public /*{LineCap}*/ CodeList[] family() {
        return values();
    }
}