001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2009-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.acquisition;
033
034 import java.util.ArrayList;
035 import java.util.List;
036
037 import org.opengis.annotation.UML;
038 import org.opengis.util.CodeList;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Temporal relation of activation.
046 *
047 * @author Cédric Briançon (Geomatys)
048 * @version 3.0
049 * @since 2.3
050 */
051 @UML(identifier="MI_SequenceCode", specification=ISO_19115_2)
052 public final class Sequence extends CodeList<Sequence> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = -3995216796996596661L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<Sequence> VALUES = new ArrayList<Sequence>(3);
063
064 /**
065 * Beginning of a collection.
066 */
067 @UML(identifier="start", obligation=CONDITIONAL, specification=ISO_19115_2)
068 public static final Sequence START = new Sequence("START");
069
070 /**
071 * End of a collection.
072 */
073 @UML(identifier="end", obligation=CONDITIONAL, specification=ISO_19115_2)
074 public static final Sequence END = new Sequence("END");
075
076 /**
077 * Collection without a significant duration
078 */
079 @UML(identifier="instantaneous", obligation=CONDITIONAL, specification=ISO_19115_2)
080 public static final Sequence INSTANTANEOUS = new Sequence("INSTANTANEOUS");
081
082 /**
083 * Constructs an enum with the given name. The new enum is
084 * automatically added to the list returned by {@link #values}.
085 *
086 * @param name The enum name. This name must not be in use by an other enum of this type.
087 */
088 private Sequence(final String name) {
089 super(name, VALUES);
090 }
091
092 /**
093 * Returns the list of {@code Sequence}s.
094 *
095 * @return The list of codes declared in the current JVM.
096 */
097 public static Sequence[] values() {
098 synchronized (VALUES) {
099 return VALUES.toArray(new Sequence[VALUES.size()]);
100 }
101 }
102
103 /**
104 * Returns the list of enumerations of the same kind than this enum.
105 */
106 @Override
107 public Sequence[] family() {
108 return values();
109 }
110
111 /**
112 * Returns the sequence that matches the given string, or returns a
113 * new one if none match it. More specifically, this methods returns the first instance for
114 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
115 * returns {@code true}. If no existing instance is found, then a new one is created for
116 * the given name.
117 *
118 * @param code The name of the code to fetch or to create.
119 * @return A code matching the given name.
120 */
121 public static Sequence valueOf(String code) {
122 return valueOf(Sequence.class, code);
123 }
124 }