001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.coverage;
033
034 import java.util.List;
035 import java.util.ArrayList;
036 import java.awt.color.ColorSpace;
037
038 import org.opengis.util.CodeList;
039 import org.opengis.annotation.UML;
040
041 import static org.opengis.annotation.Obligation.*;
042 import static org.opengis.annotation.Specification.*;
043
044
045 /**
046 * Describes the color entry in a color table.
047 *
048 * @version <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverage specification 1.0</A>
049 * @author Martin Desruisseaux (IRD)
050 * @since GeoAPI 1.0
051 *
052 * @see ColorInterpretation
053 * @see SampleDimension
054 */
055 @UML(identifier="CV_PaletteInterpretation", specification=OGC_01004)
056 public final class PaletteInterpretation extends CodeList<PaletteInterpretation> {
057 /**
058 * Serial number for compatibility with different versions.
059 */
060 private static final long serialVersionUID = -7387623392932592485L;
061
062 /**
063 * List of all enumerations of this type.
064 * Must be declared before any enum declaration.
065 */
066 private static final List<PaletteInterpretation> VALUES = new ArrayList<PaletteInterpretation>(4);
067
068 /**
069 * Gray Scale color palette.
070 *
071 * @see ColorSpace#TYPE_GRAY
072 */
073 @UML(identifier="CV_Gray", obligation=CONDITIONAL, specification=OGC_01004)
074 public static final PaletteInterpretation GRAY = new PaletteInterpretation("GRAY");
075
076 /**
077 * RGB (Red Green Blue) color palette.
078 *
079 * @see ColorSpace#TYPE_RGB
080 */
081 @UML(identifier="CV_RGB", obligation=CONDITIONAL, specification=OGC_01004)
082 public static final PaletteInterpretation RGB = new PaletteInterpretation("RGB");
083
084 /**
085 * CYMK (Cyan Yellow Magenta blacK) color palette.
086 *
087 * @see ColorSpace#TYPE_CMYK
088 */
089 @UML(identifier="CV_CMYK", obligation=CONDITIONAL, specification=OGC_01004)
090 public static final PaletteInterpretation CMYK = new PaletteInterpretation("CMYK");
091
092 /**
093 * HSL (Hue Saturation Lightness) color palette.
094 *
095 * @see ColorSpace#TYPE_HLS
096 */
097 @UML(identifier="CV_HLS", obligation=CONDITIONAL, specification=OGC_01004)
098 public static final PaletteInterpretation HLS = new PaletteInterpretation("HLS");
099
100 /**
101 * Constructs an enum with the given name. The new enum is
102 * automatically added to the list returned by {@link #values}.
103 *
104 * @param name The enum name. This name must not be in use by an other enum of this type.
105 */
106 private PaletteInterpretation(final String name) {
107 super(name, VALUES);
108 }
109
110 /**
111 * Returns the list of {@code PaletteInterpretation}s.
112 *
113 * @return The list of codes declared in the current JVM.
114 */
115 public static PaletteInterpretation[] values() {
116 synchronized (VALUES) {
117 return VALUES.toArray(new PaletteInterpretation[VALUES.size()]);
118 }
119 }
120
121 /**
122 * Returns the list of enumerations of the same kind than this enum.
123 */
124 public PaletteInterpretation[] family() {
125 return values();
126 }
127
128 /**
129 * Returns the palette interpretation that matches the given string, or returns a
130 * new one if none match it. More specifically, this methods returns the first instance for
131 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
132 * returns {@code true}. If no existing instance is found, then a new one is created for
133 * the given name.
134 *
135 * @param code The name of the code to fetch or to create.
136 * @return A code matching the given name.
137 */
138 public static PaletteInterpretation valueOf(String code) {
139 return valueOf(PaletteInterpretation.class, code);
140 }
141 }