com.phloc.commons.changelog.EChangeLogAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-commons Show documentation

phloc very basic stuff

There is a newer version: 5.0.0

/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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.
 */
package com.phloc.commons.changelog;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.id.IHasID;
import com.phloc.commons.lang.EnumHelper;

/**
 * Represents the possible actions in a change log.
 * 
 * @author Philip Helger
 */
public enum EChangeLogAction implements IHasID 
{
  ADD ("add"),
  REMOVE ("remove"),
  CHANGE ("change"),
  FIX ("fix"),
  UPDATE ("update");

  private final String m_sID;

  private EChangeLogAction (@Nonnull @Nonempty final String sID)
  {
    m_sID = sID;
  }

  @Nonnull
  @Nonempty
  public String getID ()
  {
    return m_sID;
  }

  @Nullable
  public static EChangeLogAction getFromIDOrNull (@Nullable final String sID)
  {
    return EnumHelper.getFromIDOrNull (EChangeLogAction.class, sID);
  }

  @Nullable
  public static EChangeLogAction getFromIDOrDefault (@Nullable final String sID,
                                                     @Nullable final EChangeLogAction eDefault)
  {
    return EnumHelper.getFromIDOrDefault (EChangeLogAction.class, sID, eDefault);
  }
}