State.java

/* 
 * Licensed under the Apache License, Version 2.0 (the "License");
 *
 * You may not use this file except in compliance with the License.
 *
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributions from 2013-2017 where performed either by US government 
 * employees, or under US Veterans Health Administration contracts. 
 *
 * US Veterans Health Administration contributions by government employees
 * are work of the U.S. Government and are not subject to copyright
 * protection in the United States. Portions contributed by government 
 * employees are USGovWork (17USC §105). Not subject to copyright. 
 * 
 * Contribution by contractors to the US Veterans Health Administration
 * during this period are contractually contributed under the
 * Apache License, Version 2.0.
 *
 * See: https://www.usa.gov/government-works
 * 
 * Contributions prior to 2013:
 *
 * Copyright (C) International Health Terminology Standards Development Organisation.
 * Licensed under the Apache License, Version 2.0.
 *
 */



package sh.isaac.api;

//~--- JDK imports ------------------------------------------------------------

import java.util.EnumSet;

//~--- enums ------------------------------------------------------------------

/**
 * The Enum State.
 *
 * @author kec
 */
public enum State {
   /**
    * Currently inactive.
    */
   INACTIVE(false, "Inactive", "I"),

   /**
    * Currently active.
    */
   ACTIVE(true, "Active", "A"),

   /**
    * Not yet created.
    */
   PRIMORDIAL(false, "Primordial", "P"),

   /**
    * Canceled prior to commit.
    */
   CANCELED(false, "Canceled", "C");

   /** The active only set. */
   public static EnumSet<State> ACTIVE_ONLY_SET = EnumSet.of(State.ACTIVE);

   /** The any state set. */
   public static EnumSet<State> ANY_STATE_SET = EnumSet.allOf(State.class);

   //~--- fields --------------------------------------------------------------

   /** The is active. */
   boolean isActive;

   /** The name. */
   String name;

   /** The abbreviation. */
   String abbreviation;

   //~--- constructors --------------------------------------------------------

   /**
    * Instantiates a new state.
    *
    * @param isActive the is active
    * @param name the name
    * @param abbreviation the abbreviation
    */
   State(boolean isActive, String name, String abbreviation) {
      this.isActive     = isActive;
      this.name         = name;
      this.abbreviation = abbreviation;
   }

   //~--- methods -------------------------------------------------------------

   /**
    * Inverse.
    *
    * @return the state
    */
   public State inverse() {
      switch (this) {
      case ACTIVE:
         return INACTIVE;

      case INACTIVE:
         return ACTIVE;

      default:
         return this;
      }
   }

   /**
    * To string.
    *
    * @return the string
    */
   @Override
   public String toString() {
      return this.name;
   }

   //~--- get methods ---------------------------------------------------------

   /**
    * Gets the abbreviation.
    *
    * @return the abbreviation
    */
   public String getAbbreviation() {
      return this.abbreviation;
   }

   /**
    * Checks if active.
    *
    * @return true, if active
    */
   public boolean isActive() {
      return this.isActive;
   }

   /**
    * Gets the boolean.
    *
    * @return the boolean
    */
   public boolean getBoolean() {
      return this.isActive;
   }

   /**
    * Gets the from boolean.
    *
    * @param isActive the is active
    * @return the from boolean
    */
   public static State getFromBoolean(boolean isActive) {
      if (isActive) {
         return ACTIVE;
      }

      return INACTIVE;
   }
}