001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2009-2013 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 * Mechanism of activation.
046 *
047 * @author Cédric Briançon (Geomatys)
048 * @since 2.3
049 * @version 3.0
050 */
051 @UML(identifier="MI_TriggerCode", specification=ISO_19115_2)
052 public final class Trigger extends CodeList<Trigger> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = 649620597963351153L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<Trigger> VALUES = new ArrayList<Trigger>(3);
063
064 /**
065 * Event due to external stimuli.
066 */
067 @UML(identifier="automatic", obligation=CONDITIONAL, specification=ISO_19115_2)
068 public static final Trigger AUTOMATIC = new Trigger("AUTOMATIC");
069
070 /**
071 * Event manually instigated.
072 */
073 @UML(identifier="manual", obligation=CONDITIONAL, specification=ISO_19115_2)
074 public static final Trigger MANUAL = new Trigger("MANUAL");
075
076 /**
077 * Event instigated by planned internal stimuli.
078 */
079 @UML(identifier="preProgrammed", obligation=CONDITIONAL, specification=ISO_19115_2)
080 public static final Trigger PRE_PROGRAMMED = new Trigger("PRE_PROGRAMMED");
081
082 /**
083 * Constructs an element of the given name. The new element is
084 * automatically added to the list returned by {@link #values()}.
085 *
086 * @param name The name of the new element.
087 * This name must not be in use by an other element of this type.
088 */
089 private Trigger(final String name) {
090 super(name, VALUES);
091 }
092
093 /**
094 * Returns the list of {@code Trigger}s.
095 *
096 * @return The list of codes declared in the current JVM.
097 */
098 public static Trigger[] values() {
099 synchronized (VALUES) {
100 return VALUES.toArray(new Trigger[VALUES.size()]);
101 }
102 }
103
104 /**
105 * Returns the list of codes of the same kind than this code list element.
106 * Invoking this method is equivalent to invoking {@link #values()}, except that
107 * this method can be invoked on an instance of the parent {@code CodeList} class.
108 */
109 @Override
110 public Trigger[] family() {
111 return values();
112 }
113
114 /**
115 * Returns the trigger that matches the given string, or returns a
116 * new one if none match it. More specifically, this methods returns the first instance for
117 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
118 * returns {@code true}. If no existing instance is found, then a new one is created for
119 * the given name.
120 *
121 * @param code The name of the code to fetch or to create.
122 * @return A code matching the given name.
123 */
124 public static Trigger valueOf(String code) {
125 return valueOf(Trigger.class, code);
126 }
127 }