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.metadata.constraint;
033
034 import java.util.List;
035 import java.util.ArrayList;
036
037 import org.opengis.util.CodeList;
038 import org.opengis.annotation.UML;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Name of the handling restrictions on the dataset.
046 *
047 * @author Martin Desruisseaux (IRD)
048 * @version 3.0
049 * @since 2.0
050 */
051 @UML(identifier="MD_ClassificationCode", specification=ISO_19115)
052 public final class Classification extends CodeList<Classification> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = -549174931332214797L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<Classification> VALUES = new ArrayList<Classification>(5);
063
064 /**
065 * Available for general disclosure.
066 */
067 @UML(identifier="unclassified", obligation=CONDITIONAL, specification=ISO_19115)
068 public static final Classification UNCLASSIFIED = new Classification("UNCLASSIFIED");
069
070 /**
071 * Not for general disclosure.
072 */
073 @UML(identifier="restricted", obligation=CONDITIONAL, specification=ISO_19115)
074 public static final Classification RESTRICTED = new Classification("RESTRICTED");
075
076 /**
077 * Available for someone who can be entrusted with information.
078 */
079 @UML(identifier="confidential", obligation=CONDITIONAL, specification=ISO_19115)
080 public static final Classification CONFIDENTIAL = new Classification("CONFIDENTIAL");
081
082 /**
083 * Kept or meant to be kept private, unknown, or hidden from all but a select group of people.
084 */
085 @UML(identifier="secret", obligation=CONDITIONAL, specification=ISO_19115)
086 public static final Classification SECRET = new Classification("SECRET");
087
088 /**
089 * Of the highest secrecy.
090 */
091 @UML(identifier="topSecret", obligation=CONDITIONAL, specification=ISO_19115)
092 public static final Classification TOP_SECRET = new Classification("TOP_SECRET");
093
094 /**
095 * Constructs an enum with the given name. The new enum is
096 * automatically added to the list returned by {@link #values}.
097 *
098 * @param name The enum name. This name must not be in use by an other enum of this type.
099 */
100 private Classification(final String name) {
101 super(name, VALUES);
102 }
103
104 /**
105 * Returns the list of {@code Classification}s.
106 *
107 * @return The list of codes declared in the current JVM.
108 */
109 public static Classification[] values() {
110 synchronized (VALUES) {
111 return VALUES.toArray(new Classification[VALUES.size()]);
112 }
113 }
114
115 /**
116 * Returns the list of enumerations of the same kind than this enum.
117 */
118 @Override
119 public Classification[] family() {
120 return values();
121 }
122
123 /**
124 * Returns the classification that matches the given string, or returns a
125 * new one if none match it. More specifically, this methods returns the first instance for
126 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
127 * returns {@code true}. If no existing instance is found, then a new one is created for
128 * the given name.
129 *
130 * @param code The name of the code to fetch or to create.
131 * @return A code matching the given name.
132 */
133 public static Classification valueOf(String code) {
134 return valueOf(Classification.class, code);
135 }
136 }