plugins/org.eclipse.osee.framework.core/src/org/eclipse/osee/framework/core/enums/OseeEnum.java

/*******************************************************************************
 * Copyright (c) 2020 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.framework.core.enums;

import java.util.Collection;
import java.util.Collections;
import org.eclipse.osee.framework.jdk.core.type.HashCollection;
import org.eclipse.osee.framework.jdk.core.type.NamedIdBase;

/**
 * Simple Enum class that provides few things over enum class.</br>
 * </br>
 * 1) It searilizes/desearilizes automatically</br>
 * 2) Provides a default get(String) method that doesn't exception if no match</br>
 * 3) Other parameters can be easily added while named/id is automatic</br>
 *
 * @author Donald G. Dunne
 */
public abstract class OseeEnum extends NamedIdBase {
   protected static final HashCollection<Long, OseeEnum> idToEnums = new HashCollection<Long, OseeEnum>(15);

   /**
    * Add enum with next ordinal
    */
   public OseeEnum(Long typeId, String name) {
      super(-1L, name);
      setId(Long.valueOf(values().size()));
      idToEnums.put(typeId, this);
   }

   public OseeEnum(Long typeId, Long ordinal, String name) {
      super(ordinal, name);
      idToEnums.put(typeId, this);
   }

   abstract public Long getTypeId();

   abstract public OseeEnum getDefault();

   /**
    * @return OseeEnum matching name or sentinel
    */
   public OseeEnum get(String name) {
      for (OseeEnum oEnum : idToEnums.getValues(getTypeId())) {
         if (oEnum.name().equals(name)) {
            return oEnum;
         }
      }
      return getDefault();
   }

   public String name() {
      return getName();
   }

   public Collection<OseeEnum> values() {
      Collection<OseeEnum> values = idToEnums.getValues(getTypeId());
      if (values == null) {
         return Collections.emptyList();
      }
      return values;
   }

}