org.cp.elements.enums.TimeUnit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 Author or Authors.
 *
 * 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 org.cp.elements.enums;

import java.util.Arrays;

/**
 * The {@link TimeUnit} enum is an {@link Enum enumeration} for units of time.
 *
 * @author John J. Blum
 * @see java.lang.Enum
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public enum TimeUnit {

  NANOSECOND("ns", "Nanosecond", "1 billionth of a second"),
  MICROSECOND("us", "Microsecond", "1 millionth of a second"),
  MILLISECOND("ms", "Millisecond", "1 thousandth of a second"),
  SECOND("s", "Second", "1 second"),
  MINUTE("mi", "Minute", "60 seconds"),
  HOUR("hr", "Hour", "60 minutes"),
  DAY("day", "Day", "24 hours"),
  WEEK("wk", "Week", "7 days"),
  MONTH("mon", "Month", "28-31 days"),
  YEAR("yr", "Year", "12 months, 365 days"),
  DECADE("dec", "Decade", "10 years"),
  SCORE("Score", "Score", "20 years"),
  CENTURY("cent", "Century", "100 years"),
  MILLENIA("Millenia", "Millenia", "1000 years");

  public static TimeUnit valueOfAbbreviation(String abbreviation) {

    return Arrays.stream(values())
      .filter(unit -> unit.getAbbreviation().equalsIgnoreCase(abbreviation))
      .findFirst()
      .orElse(null);
  }

  public static TimeUnit valueOfName(String name) {

    return Arrays.stream(values())
      .filter(unit -> unit.getName().equalsIgnoreCase(name))
      .findFirst()
      .orElse(null);
  }

  private final String abbreviation;
  private final String description;
  private final String name;

  TimeUnit(String abbreviation, String name, String description) {
    this.abbreviation = abbreviation;
    this.name = name;
    this.description = description;
  }

  public String getAbbreviation() {
    return this.abbreviation;
  }

  public String getDescription() {
    return this.description;
  }

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

  @Override
  public String toString() {
    return getName();
  }
}